Class: ListArchivedWorkflowExecutionsRequest
workflowservice.v1.ListArchivedWorkflowExecutionsRequest
Represents a ListArchivedWorkflowExecutionsRequest.
Implements
Constructors
constructor
• new ListArchivedWorkflowExecutionsRequest(properties?): ListArchivedWorkflowExecutionsRequest
Constructs a new ListArchivedWorkflowExecutionsRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IListArchivedWorkflowExecutionsRequest | Properties to set |
Returns
ListArchivedWorkflowExecutionsRequest
Properties
namespace
• namespace: string
ListArchivedWorkflowExecutionsRequest namespace.
Implementation of
IListArchivedWorkflowExecutionsRequest.namespace
nextPageToken
• nextPageToken: Uint8Array
ListArchivedWorkflowExecutionsRequest nextPageToken.
Implementation of
IListArchivedWorkflowExecutionsRequest.nextPageToken
pageSize
• pageSize: number
ListArchivedWorkflowExecutionsRequest pageSize.
Implementation of
IListArchivedWorkflowExecutionsRequest.pageSize
query
• query: string
ListArchivedWorkflowExecutionsRequest query.
Implementation of
IListArchivedWorkflowExecutionsRequest.query
Methods
toJSON
▸ toJSON(): Object
Converts this ListArchivedWorkflowExecutionsRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ListArchivedWorkflowExecutionsRequest
Creates a new ListArchivedWorkflowExecutionsRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IListArchivedWorkflowExecutionsRequest | Properties to set |
Returns
ListArchivedWorkflowExecutionsRequest
ListArchivedWorkflowExecutionsRequest instance
decode
▸ decode(reader, length?): ListArchivedWorkflowExecutionsRequest
Decodes a ListArchivedWorkflowExecutionsRequest message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
ListArchivedWorkflowExecutionsRequest
ListArchivedWorkflowExecutionsRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ListArchivedWorkflowExecutionsRequest
Decodes a ListArchivedWorkflowExecutionsRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ListArchivedWorkflowExecutionsRequest
ListArchivedWorkflowExecutionsRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified ListArchivedWorkflowExecutionsRequest message. Does not implicitly temporal.api.workflowservice.v1.ListArchivedWorkflowExecutionsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IListArchivedWorkflowExecutionsRequest | ListArchivedWorkflowExecutionsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ListArchivedWorkflowExecutionsRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.ListArchivedWorkflowExecutionsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IListArchivedWorkflowExecutionsRequest | ListArchivedWorkflowExecutionsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ListArchivedWorkflowExecutionsRequest
Creates a ListArchivedWorkflowExecutionsRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ListArchivedWorkflowExecutionsRequest
ListArchivedWorkflowExecutionsRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ListArchivedWorkflowExecutionsRequest
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ListArchivedWorkflowExecutionsRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ListArchivedWorkflowExecutionsRequest | ListArchivedWorkflowExecutionsRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object