Skip to main content

Class: CancelWorkflowExecutionCommandAttributes

Represents a CancelWorkflowExecutionCommandAttributes.

Properties​

details?​

optional details?: $Properties | null

CancelWorkflowExecutionCommandAttributes details.

Methods​

toJSON()​

toJSON(): object

Converts this CancelWorkflowExecutionCommandAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CancelWorkflowExecutionCommandAttributes & $Properties

Creates a new CancelWorkflowExecutionCommandAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelWorkflowExecutionCommandAttributes & $Properties

CancelWorkflowExecutionCommandAttributes instance

Call Signature​

static create(properties?): CancelWorkflowExecutionCommandAttributes

Creates a new CancelWorkflowExecutionCommandAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelWorkflowExecutionCommandAttributes

CancelWorkflowExecutionCommandAttributes instance

decode()​

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

Decodes a CancelWorkflowExecutionCommandAttributes message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message 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()​

static decodeDelimited(reader): CancelWorkflowExecutionCommandAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader 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()​

static encode(message, writer?): Writer

Encodes the specified CancelWorkflowExecutionCommandAttributes message. Does not implicitly temporal.api.command.v1.CancelWorkflowExecutionCommandAttributes.verify|verify messages.

Parameters​

message​

$Properties

CancelWorkflowExecutionCommandAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified CancelWorkflowExecutionCommandAttributes message, length delimited. Does not implicitly temporal.api.command.v1.CancelWorkflowExecutionCommandAttributes.verify|verify messages.

Parameters​

message​

$Properties

CancelWorkflowExecutionCommandAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CancelWorkflowExecutionCommandAttributes

Creates a CancelWorkflowExecutionCommandAttributes message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

CancelWorkflowExecutionCommandAttributes

CancelWorkflowExecutionCommandAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CancelWorkflowExecutionCommandAttributes

CancelWorkflowExecutionCommandAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object