Class: CancelWorkflowExecutionCommandAttributes
command.v1.CancelWorkflowExecutionCommandAttributes
Represents a CancelWorkflowExecutionCommandAttributes.
Implements
Constructors
constructor
• new CancelWorkflowExecutionCommandAttributes(properties?): CancelWorkflowExecutionCommandAttributes
Constructs a new CancelWorkflowExecutionCommandAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICancelWorkflowExecutionCommandAttributes | Properties to set |
Returns
CancelWorkflowExecutionCommandAttributes
Properties
details
• Optional details: null | IPayloads
CancelWorkflowExecutionCommandAttributes details.
Implementation of
ICancelWorkflowExecutionCommandAttributes.details
Methods
toJSON
▸ toJSON(): Object
Converts this CancelWorkflowExecutionCommandAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CancelWorkflowExecutionCommandAttributes
Creates a new CancelWorkflowExecutionCommandAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICancelWorkflowExecutionCommandAttributes | Properties to set |
Returns
CancelWorkflowExecutionCommandAttributes
CancelWorkflowExecutionCommandAttributes instance
decode
▸ decode(reader, length?): CancelWorkflowExecutionCommandAttributes
Decodes a CancelWorkflowExecutionCommandAttributes 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
CancelWorkflowExecutionCommandAttributes
CancelWorkflowExecutionCommandAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CancelWorkflowExecutionCommandAttributes
Decodes a CancelWorkflowExecutionCommandAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CancelWorkflowExecutionCommandAttributes
CancelWorkflowExecutionCommandAttributes
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 CancelWorkflowExecutionCommandAttributes message. Does not implicitly temporal.api.command.v1.CancelWorkflowExecutionCommandAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICancelWorkflowExecutionCommandAttributes | CancelWorkflowExecutionCommandAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CancelWorkflowExecutionCommandAttributes message, length delimited. Does not implicitly temporal.api.command.v1.CancelWorkflowExecutionCommandAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICancelWorkflowExecutionCommandAttributes | CancelWorkflowExecutionCommandAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CancelWorkflowExecutionCommandAttributes
Creates a CancelWorkflowExecutionCommandAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CancelWorkflowExecutionCommandAttributes
CancelWorkflowExecutionCommandAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for CancelWorkflowExecutionCommandAttributes
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 CancelWorkflowExecutionCommandAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CancelWorkflowExecutionCommandAttributes | CancelWorkflowExecutionCommandAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object