Class: ListActivityExecutionsRequest
workflowservice.v1.ListActivityExecutionsRequest
Represents a ListActivityExecutionsRequest.
Properties
namespace
• namespace: string
ListActivityExecutionsRequest namespace.
nextPageToken
• nextPageToken: Uint8Array
Token returned in ListActivityExecutionsResponse.
pageSize
• pageSize: number
Max number of executions to return per page.
query
• query: string
Visibility query, see https://docs.temporal.io/list-filter for the syntax.
Methods
toJSON
▸ toJSON(): Object
Converts this ListActivityExecutionsRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ListActivityExecutionsRequest & $Properties
Creates a new ListActivityExecutionsRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ListActivityExecutionsRequest & $Properties
ListActivityExecutionsRequest instance
▸ create(properties?): ListActivityExecutionsRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ListActivityExecutionsRequest & $Properties
Decodes a ListActivityExecutionsRequest 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
ListActivityExecutionsRequest & $Properties
ListActivityExecutionsRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ListActivityExecutionsRequest & $Properties
Decodes a ListActivityExecutionsRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ListActivityExecutionsRequest & $Properties
ListActivityExecutionsRequest
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 ListActivityExecutionsRequest message. Does not implicitly temporal.api.workflowservice.v1.ListActivityExecutionsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ListActivityExecutionsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ListActivityExecutionsRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.ListActivityExecutionsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ListActivityExecutionsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ListActivityExecutionsRequest
Creates a ListActivityExecutionsRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ListActivityExecutionsRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ListActivityExecutionsRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ListActivityExecutionsRequest | ListActivityExecutionsRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object