Skip to main content

Class: WorkflowExecutionCancelRequestedEventAttributes

Represents a WorkflowExecutionCancelRequestedEventAttributes.

Properties​

cause​

cause: string

User provided reason for requesting cancellation

externalInitiatedEventId​

externalInitiatedEventId: Long

The ID of the REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED event in the external workflow history when the cancellation was requested by another workflow.

externalWorkflowExecution?​

optional externalWorkflowExecution?: $Properties | null

WorkflowExecutionCancelRequestedEventAttributes externalWorkflowExecution.

identity​

identity: string

id of the worker or client who requested this cancel

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowExecutionCancelRequestedEventAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowExecutionCancelRequestedEventAttributes & $Properties

Creates a new WorkflowExecutionCancelRequestedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecutionCancelRequestedEventAttributes & $Properties

WorkflowExecutionCancelRequestedEventAttributes instance

Call Signature​

static create(properties?): WorkflowExecutionCancelRequestedEventAttributes

Creates a new WorkflowExecutionCancelRequestedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecutionCancelRequestedEventAttributes

WorkflowExecutionCancelRequestedEventAttributes instance

decode()​

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

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

WorkflowExecutionCancelRequestedEventAttributes & $Properties

WorkflowExecutionCancelRequestedEventAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowExecutionCancelRequestedEventAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowExecutionCancelRequestedEventAttributes & $Properties

WorkflowExecutionCancelRequestedEventAttributes

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

Parameters​

message​

$Properties

WorkflowExecutionCancelRequestedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowExecutionCancelRequestedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowExecutionCancelRequestedEventAttributes

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

Parameters​

object​

Plain object

Returns​

WorkflowExecutionCancelRequestedEventAttributes

WorkflowExecutionCancelRequestedEventAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowExecutionCancelRequestedEventAttributes

WorkflowExecutionCancelRequestedEventAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object