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