Skip to main content

Class: RequestCancelExternalWorkflowExecutionCommandAttributes

Represents a RequestCancelExternalWorkflowExecutionCommandAttributes.

Properties​

childWorkflowOnly​

childWorkflowOnly: boolean

Set this to true if the workflow being cancelled is a child of the workflow originating this command. The request will be rejected if it is set to true and the target workflow is not a child of the requesting workflow.

control​

control: string

Deprecated.

namespace​

namespace: string

Deprecated. Cross-namespace operations are disabled by default as of server 1.30.1.

reason​

reason: string

Reason for requesting the cancellation

runId​

runId: string

RequestCancelExternalWorkflowExecutionCommandAttributes runId.

workflowId​

workflowId: string

RequestCancelExternalWorkflowExecutionCommandAttributes workflowId.

Methods​

toJSON()​

toJSON(): object

Converts this RequestCancelExternalWorkflowExecutionCommandAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): RequestCancelExternalWorkflowExecutionCommandAttributes & $Properties

Creates a new RequestCancelExternalWorkflowExecutionCommandAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RequestCancelExternalWorkflowExecutionCommandAttributes & $Properties

RequestCancelExternalWorkflowExecutionCommandAttributes instance

Call Signature​

static create(properties?): RequestCancelExternalWorkflowExecutionCommandAttributes

Creates a new RequestCancelExternalWorkflowExecutionCommandAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RequestCancelExternalWorkflowExecutionCommandAttributes

RequestCancelExternalWorkflowExecutionCommandAttributes instance

decode()​

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

Decodes a RequestCancelExternalWorkflowExecutionCommandAttributes 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​

RequestCancelExternalWorkflowExecutionCommandAttributes & $Properties

RequestCancelExternalWorkflowExecutionCommandAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): RequestCancelExternalWorkflowExecutionCommandAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

RequestCancelExternalWorkflowExecutionCommandAttributes & $Properties

RequestCancelExternalWorkflowExecutionCommandAttributes

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 RequestCancelExternalWorkflowExecutionCommandAttributes message. Does not implicitly temporal.api.command.v1.RequestCancelExternalWorkflowExecutionCommandAttributes.verify|verify messages.

Parameters​

message​

$Properties

RequestCancelExternalWorkflowExecutionCommandAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

RequestCancelExternalWorkflowExecutionCommandAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): RequestCancelExternalWorkflowExecutionCommandAttributes

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

Parameters​

object​

Plain object

Returns​

RequestCancelExternalWorkflowExecutionCommandAttributes

RequestCancelExternalWorkflowExecutionCommandAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

RequestCancelExternalWorkflowExecutionCommandAttributes

RequestCancelExternalWorkflowExecutionCommandAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object