Skip to main content

Class: ChildWorkflowExecutionCanceledEventAttributes

Represents a ChildWorkflowExecutionCanceledEventAttributes.

Properties​

details?​

optional details?: $Properties | null

ChildWorkflowExecutionCanceledEventAttributes details.

initiatedEventId​

initiatedEventId: Long

Id of the START_CHILD_WORKFLOW_EXECUTION_INITIATED event which this event corresponds to

namespace​

namespace: string

Namespace of the child workflow. SDKs and UI tools should use namespace field but server must use namespace_id only.

namespaceId​

namespaceId: string

ChildWorkflowExecutionCanceledEventAttributes namespaceId.

startedEventId​

startedEventId: Long

Id of the CHILD_WORKFLOW_EXECUTION_STARTED event which this event corresponds to

workflowExecution?​

optional workflowExecution?: $Properties | null

ChildWorkflowExecutionCanceledEventAttributes workflowExecution.

workflowType?​

optional workflowType?: $Properties | null

ChildWorkflowExecutionCanceledEventAttributes workflowType.

Methods​

toJSON()​

toJSON(): object

Converts this ChildWorkflowExecutionCanceledEventAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ChildWorkflowExecutionCanceledEventAttributes & $Properties

Creates a new ChildWorkflowExecutionCanceledEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ChildWorkflowExecutionCanceledEventAttributes & $Properties

ChildWorkflowExecutionCanceledEventAttributes instance

Call Signature​

static create(properties?): ChildWorkflowExecutionCanceledEventAttributes

Creates a new ChildWorkflowExecutionCanceledEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ChildWorkflowExecutionCanceledEventAttributes

ChildWorkflowExecutionCanceledEventAttributes instance

decode()​

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

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

ChildWorkflowExecutionCanceledEventAttributes & $Properties

ChildWorkflowExecutionCanceledEventAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ChildWorkflowExecutionCanceledEventAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ChildWorkflowExecutionCanceledEventAttributes & $Properties

ChildWorkflowExecutionCanceledEventAttributes

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

Parameters​

message​

$Properties

ChildWorkflowExecutionCanceledEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ChildWorkflowExecutionCanceledEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ChildWorkflowExecutionCanceledEventAttributes

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

Parameters​

object​

Plain object

Returns​

ChildWorkflowExecutionCanceledEventAttributes

ChildWorkflowExecutionCanceledEventAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ChildWorkflowExecutionCanceledEventAttributes

ChildWorkflowExecutionCanceledEventAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object