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