Class: CancelActivityCommand
worker.v1.CancelActivityCommand
Cancel an activity if it is still running. Otherwise, do nothing.
Properties
taskToken
• taskToken: Uint8Array
CancelActivityCommand taskToken.
Methods
toJSON
▸ toJSON(): Object
Converts this CancelActivityCommand to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CancelActivityCommand & $Properties
Creates a new CancelActivityCommand instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
CancelActivityCommand & $Properties
CancelActivityCommand instance
▸ create(properties?): CancelActivityCommand
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): CancelActivityCommand & $Properties
Decodes a CancelActivityCommand 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
CancelActivityCommand & $Properties
CancelActivityCommand
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CancelActivityCommand & $Properties
Decodes a CancelActivityCommand message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CancelActivityCommand & $Properties
CancelActivityCommand
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 CancelActivityCommand message. Does not implicitly temporal.api.worker.v1.CancelActivityCommand.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CancelActivityCommand message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CancelActivityCommand message, length delimited. Does not implicitly temporal.api.worker.v1.CancelActivityCommand.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CancelActivityCommand message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CancelActivityCommand
Creates a CancelActivityCommand message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CancelActivityCommand
toObject
▸ toObject(message, options?): Object
Creates a plain object from a CancelActivityCommand message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CancelActivityCommand | CancelActivityCommand |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object