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