Class: CancelActivityResult
worker.v1.CancelActivityResult
Result of a CancelActivityCommand. Treat both successful cancellation and no-op (activity is no longer running) as success.
Implements
Constructors
constructor
• new CancelActivityResult(properties?): CancelActivityResult
Constructs a new CancelActivityResult.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICancelActivityResult | Properties to set |
Returns
Methods
toJSON
▸ toJSON(): Object
Converts this CancelActivityResult to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CancelActivityResult
Creates a new CancelActivityResult instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICancelActivityResult | Properties to set |
Returns
CancelActivityResult instance
decode
▸ decode(reader, length?): CancelActivityResult
Decodes a CancelActivityResult 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
CancelActivityResult
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CancelActivityResult
Decodes a CancelActivityResult message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CancelActivityResult
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 CancelActivityResult message. Does not implicitly temporal.api.worker.v1.CancelActivityResult.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICancelActivityResult | CancelActivityResult message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CancelActivityResult message, length delimited. Does not implicitly temporal.api.worker.v1.CancelActivityResult.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICancelActivityResult | CancelActivityResult message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CancelActivityResult
Creates a CancelActivityResult message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CancelActivityResult
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for CancelActivityResult
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 CancelActivityResult message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CancelActivityResult | CancelActivityResult |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object