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