Skip to main content

Class: RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

Represents a RequestCancelExternalWorkflowExecutionInitiatedEventAttributes.

Properties​

childWorkflowOnly​

childWorkflowOnly: boolean

Workers are expected to set this to true if the workflow they are requesting to cancel is a child of the workflow which issued the request

control​

control: string

Deprecated.

namespace​

namespace: string

The namespace the workflow to be cancelled lives in. SDKs and UI tools should use namespace field but server must use namespace_id only.

namespaceId​

namespaceId: string

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes namespaceId.

reason​

reason: string

Reason for requesting the cancellation

workflowExecution?​

optional workflowExecution?: $Properties | null

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes workflowExecution.

workflowTaskCompletedEventId​

workflowTaskCompletedEventId: Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

Methods​

toJSON()​

toJSON(): object

Converts this RequestCancelExternalWorkflowExecutionInitiatedEventAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): RequestCancelExternalWorkflowExecutionInitiatedEventAttributes & $Properties

Creates a new RequestCancelExternalWorkflowExecutionInitiatedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes & $Properties

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes instance

Call Signature​

static create(properties?): RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

Creates a new RequestCancelExternalWorkflowExecutionInitiatedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes instance

decode()​

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

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

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes & $Properties

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): RequestCancelExternalWorkflowExecutionInitiatedEventAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes & $Properties

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

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

Parameters​

message​

$Properties

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

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

Parameters​

object​

Plain object

Returns​

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object