Class: TerminateActivityExecutionRequest
workflowservice.v1.TerminateActivityExecutionRequest
Represents a TerminateActivityExecutionRequest.
Properties
activityId
• activityId: string
TerminateActivityExecutionRequest activityId.
identity
• identity: string
The identity of the worker/client.
namespace
• namespace: string
TerminateActivityExecutionRequest namespace.
reason
• reason: string
Reason for requesting the termination, recorded in in the activity's result failure outcome.
requestId
• requestId: string
Used to de-dupe termination requests.
runId
• runId: string
Activity run ID. If empty, targets the latest run.
Methods
toJSON
▸ toJSON(): Object
Converts this TerminateActivityExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): TerminateActivityExecutionRequest & $Properties
Creates a new TerminateActivityExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
TerminateActivityExecutionRequest & $Properties
TerminateActivityExecutionRequest instance
▸ create(properties?): TerminateActivityExecutionRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
TerminateActivityExecutionRequest
decode
▸ decode(reader, length?): TerminateActivityExecutionRequest & $Properties
Decodes a TerminateActivityExecutionRequest 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
TerminateActivityExecutionRequest & $Properties
TerminateActivityExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): TerminateActivityExecutionRequest & $Properties
Decodes a TerminateActivityExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
TerminateActivityExecutionRequest & $Properties
TerminateActivityExecutionRequest
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 TerminateActivityExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.TerminateActivityExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | TerminateActivityExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified TerminateActivityExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.TerminateActivityExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | TerminateActivityExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): TerminateActivityExecutionRequest
Creates a TerminateActivityExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
TerminateActivityExecutionRequest
TerminateActivityExecutionRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a TerminateActivityExecutionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | TerminateActivityExecutionRequest | TerminateActivityExecutionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object