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