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