Class: DescribeActivityExecutionResponse
workflowservice.v1.DescribeActivityExecutionResponse
Represents a DescribeActivityExecutionResponse.
Implements
Constructors
constructor
• new DescribeActivityExecutionResponse(properties?): DescribeActivityExecutionResponse
Constructs a new DescribeActivityExecutionResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDescribeActivityExecutionResponse | Properties to set |
Returns
DescribeActivityExecutionResponse
Properties
callbacks
• callbacks: ICallbackInfo[]
Callbacks attached to this activity execution and their current state.
Implementation of
IDescribeActivityExecutionResponse.callbacks
info
• Optional info: null | IActivityExecutionInfo
Information about the activity execution. Fields heartbeat_details and last_failure are omitted unless the request has include_heartbeat_details or include_last_failure set to true, respectively.
Implementation of
IDescribeActivityExecutionResponse.info
input
• Optional input: null | IPayloads
Serialized activity input, passed as arguments to the activity function. Only set if include_input was true in the request.
Implementation of
IDescribeActivityExecutionResponse.input
longPollToken
• longPollToken: Uint8Array
Token for follow-on long-poll requests. Absent only if the activity is complete.
Implementation of
IDescribeActivityExecutionResponse.longPollToken
outcome
• Optional outcome: null | IActivityExecutionOutcome
Only set if the activity is completed and include_outcome was true in the request.
Implementation of
IDescribeActivityExecutionResponse.outcome
runId
• runId: string
The run ID of the activity, useful when run_id was not specified in the request.
Implementation of
IDescribeActivityExecutionResponse.runId
Methods
toJSON
▸ toJSON(): Object
Converts this DescribeActivityExecutionResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DescribeActivityExecutionResponse
Creates a new DescribeActivityExecutionResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDescribeActivityExecutionResponse | Properties to set |
Returns
DescribeActivityExecutionResponse
DescribeActivityExecutionResponse instance
decode
▸ decode(reader, length?): DescribeActivityExecutionResponse
Decodes a DescribeActivityExecutionResponse 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
DescribeActivityExecutionResponse
DescribeActivityExecutionResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DescribeActivityExecutionResponse
Decodes a DescribeActivityExecutionResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DescribeActivityExecutionResponse
DescribeActivityExecutionResponse
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 DescribeActivityExecutionResponse message. Does not implicitly temporal.api.workflowservice.v1.DescribeActivityExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDescribeActivityExecutionResponse | DescribeActivityExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DescribeActivityExecutionResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DescribeActivityExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDescribeActivityExecutionResponse | DescribeActivityExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DescribeActivityExecutionResponse
Creates a DescribeActivityExecutionResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DescribeActivityExecutionResponse
DescribeActivityExecutionResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for DescribeActivityExecutionResponse
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 DescribeActivityExecutionResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DescribeActivityExecutionResponse | DescribeActivityExecutionResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object