Skip to main content

Class: CancelWorkflowExecutionCommandAttributes

command.v1.CancelWorkflowExecutionCommandAttributes

Represents a CancelWorkflowExecutionCommandAttributes.

Properties​

details​

• Optional details: null | $Properties

CancelWorkflowExecutionCommandAttributes details.

Methods​

toJSON​

▸ toJSON(): Object

Converts this CancelWorkflowExecutionCommandAttributes to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): CancelWorkflowExecutionCommandAttributes & $Properties

Creates a new CancelWorkflowExecutionCommandAttributes instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

CancelWorkflowExecutionCommandAttributes & $Properties

CancelWorkflowExecutionCommandAttributes instance

▸ create(properties?): CancelWorkflowExecutionCommandAttributes

Parameters​

NameType
properties?$Properties

Returns​

CancelWorkflowExecutionCommandAttributes


decode​

▸ decode(reader, length?): CancelWorkflowExecutionCommandAttributes & $Properties

Decodes a CancelWorkflowExecutionCommandAttributes message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

CancelWorkflowExecutionCommandAttributes & $Properties

CancelWorkflowExecutionCommandAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): CancelWorkflowExecutionCommandAttributes & $Properties

Decodes a CancelWorkflowExecutionCommandAttributes message from the specified reader or buffer, length delimited.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

CancelWorkflowExecutionCommandAttributes & $Properties

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​

NameTypeDescription
message$PropertiesCancelWorkflowExecutionCommandAttributes message or plain object to encode
writer?WriterWriter 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​

NameTypeDescription
message$PropertiesCancelWorkflowExecutionCommandAttributes message or plain object to encode
writer?WriterWriter 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​

NameTypeDescription
objectObjectPlain object

Returns​

CancelWorkflowExecutionCommandAttributes

CancelWorkflowExecutionCommandAttributes


toObject​

▸ toObject(message, options?): Object

Creates a plain object from a CancelWorkflowExecutionCommandAttributes message. Also converts values to other types if specified.

Parameters​

NameTypeDescription
messageCancelWorkflowExecutionCommandAttributesCancelWorkflowExecutionCommandAttributes
options?IConversionOptionsConversion options

Returns​

Object

Plain object