Class: BatchOperationTerminateActivities
batch.v1.BatchOperationTerminateActivities
BatchOperationTerminateActivities sends terminate requests to a batch of activities. Keep the parameter in sync with temporal.api.workflowservice.v1.TerminateActivityExecutionRequest.
Properties
identity
• identity: string
The identity of the worker/client
reason
• reason: string
Reason for requesting the termination, recorded and available via the PollActivityExecution API. Not propagated to a worker if an activity attempt is currently running.
Methods
toJSON
▸ toJSON(): Object
Converts this BatchOperationTerminateActivities to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BatchOperationTerminateActivities & $Properties
Creates a new BatchOperationTerminateActivities instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
BatchOperationTerminateActivities & $Properties
BatchOperationTerminateActivities instance
▸ create(properties?): BatchOperationTerminateActivities
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
BatchOperationTerminateActivities
decode
▸ decode(reader, length?): BatchOperationTerminateActivities & $Properties
Decodes a BatchOperationTerminateActivities 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
BatchOperationTerminateActivities & $Properties
BatchOperationTerminateActivities
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BatchOperationTerminateActivities & $Properties
Decodes a BatchOperationTerminateActivities message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BatchOperationTerminateActivities & $Properties
BatchOperationTerminateActivities
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 BatchOperationTerminateActivities message. Does not implicitly temporal.api.batch.v1.BatchOperationTerminateActivities.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BatchOperationTerminateActivities message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BatchOperationTerminateActivities message, length delimited. Does not implicitly temporal.api.batch.v1.BatchOperationTerminateActivities.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BatchOperationTerminateActivities message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BatchOperationTerminateActivities
Creates a BatchOperationTerminateActivities message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BatchOperationTerminateActivities
BatchOperationTerminateActivities
toObject
▸ toObject(message, options?): Object
Creates a plain object from a BatchOperationTerminateActivities message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BatchOperationTerminateActivities | BatchOperationTerminateActivities |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object