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