Class: TerminateActivityExecutionRequest
workflowservice.v1.TerminateActivityExecutionRequest
Represents a TerminateActivityExecutionRequest.
Implements
Constructors
constructor
• new TerminateActivityExecutionRequest(properties?): TerminateActivityExecutionRequest
Constructs a new TerminateActivityExecutionRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ITerminateActivityExecutionRequest | Properties to set |
Returns
TerminateActivityExecutionRequest
Properties
activityId
• activityId: string
TerminateActivityExecutionRequest activityId.
Implementation of
ITerminateActivityExecutionRequest.activityId
identity
• identity: string
The identity of the worker/client.
Implementation of
ITerminateActivityExecutionRequest.identity
namespace
• namespace: string
TerminateActivityExecutionRequest namespace.
Implementation of
ITerminateActivityExecutionRequest.namespace
reason
• reason: string
Reason for requesting the termination, recorded in in the activity's result failure outcome.
Implementation of
ITerminateActivityExecutionRequest.reason
requestId
• requestId: string
Used to de-dupe termination requests.
Implementation of
ITerminateActivityExecutionRequest.requestId
runId
• runId: string
Activity run ID, targets the latest run if run_id is empty.
Implementation of
ITerminateActivityExecutionRequest.runId
Methods
toJSON
▸ toJSON(): Object
Converts this TerminateActivityExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): TerminateActivityExecutionRequest
Creates a new TerminateActivityExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ITerminateActivityExecutionRequest | Properties to set |
Returns
TerminateActivityExecutionRequest
TerminateActivityExecutionRequest instance
decode
▸ decode(reader, length?): TerminateActivityExecutionRequest
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
TerminateActivityExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): TerminateActivityExecutionRequest
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
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 | ITerminateActivityExecutionRequest | 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 | ITerminateActivityExecutionRequest | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for TerminateActivityExecutionRequest
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 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