Skip to main content

Class: ExternalWorkflowExecutionCancelRequestedEventAttributes

Represents an ExternalWorkflowExecutionCancelRequestedEventAttributes.

Properties​

initiatedEventId​

initiatedEventId: Long

id of the REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED event this event corresponds to

namespace​

namespace: string

Namespace of the to-be-cancelled workflow. SDKs and UI tools should use namespace field but server must use namespace_id only.

namespaceId​

namespaceId: string

ExternalWorkflowExecutionCancelRequestedEventAttributes namespaceId.

workflowExecution?​

optional workflowExecution?: $Properties | null

ExternalWorkflowExecutionCancelRequestedEventAttributes workflowExecution.

Methods​

toJSON()​

toJSON(): object

Converts this ExternalWorkflowExecutionCancelRequestedEventAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ExternalWorkflowExecutionCancelRequestedEventAttributes & $Properties

Creates a new ExternalWorkflowExecutionCancelRequestedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ExternalWorkflowExecutionCancelRequestedEventAttributes & $Properties

ExternalWorkflowExecutionCancelRequestedEventAttributes instance

Call Signature​

static create(properties?): ExternalWorkflowExecutionCancelRequestedEventAttributes

Creates a new ExternalWorkflowExecutionCancelRequestedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ExternalWorkflowExecutionCancelRequestedEventAttributes

ExternalWorkflowExecutionCancelRequestedEventAttributes instance

decode()​

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

Decodes an ExternalWorkflowExecutionCancelRequestedEventAttributes 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​

ExternalWorkflowExecutionCancelRequestedEventAttributes & $Properties

ExternalWorkflowExecutionCancelRequestedEventAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ExternalWorkflowExecutionCancelRequestedEventAttributes & $Properties

Decodes an ExternalWorkflowExecutionCancelRequestedEventAttributes message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ExternalWorkflowExecutionCancelRequestedEventAttributes & $Properties

ExternalWorkflowExecutionCancelRequestedEventAttributes

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

Parameters​

message​

$Properties

ExternalWorkflowExecutionCancelRequestedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ExternalWorkflowExecutionCancelRequestedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ExternalWorkflowExecutionCancelRequestedEventAttributes

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

Parameters​

object​

Plain object

Returns​

ExternalWorkflowExecutionCancelRequestedEventAttributes

ExternalWorkflowExecutionCancelRequestedEventAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ExternalWorkflowExecutionCancelRequestedEventAttributes

ExternalWorkflowExecutionCancelRequestedEventAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object