Skip to main content

Class: ChildWorkflowExecutionCanceledEventAttributes

history.v1.ChildWorkflowExecutionCanceledEventAttributes

Represents a ChildWorkflowExecutionCanceledEventAttributes.

Implements

Constructors

constructor

new ChildWorkflowExecutionCanceledEventAttributes(properties?): ChildWorkflowExecutionCanceledEventAttributes

Constructs a new ChildWorkflowExecutionCanceledEventAttributes.

Parameters

NameTypeDescription
properties?IChildWorkflowExecutionCanceledEventAttributesProperties to set

Returns

ChildWorkflowExecutionCanceledEventAttributes

Properties

details

Optional details: null | IPayloads

ChildWorkflowExecutionCanceledEventAttributes details.

Implementation of

IChildWorkflowExecutionCanceledEventAttributes.details


initiatedEventId

initiatedEventId: Long

Id of the START_CHILD_WORKFLOW_EXECUTION_INITIATED event which this event corresponds to

Implementation of

IChildWorkflowExecutionCanceledEventAttributes.initiatedEventId


namespace

namespace: string

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

Implementation of

IChildWorkflowExecutionCanceledEventAttributes.namespace


namespaceId

namespaceId: string

ChildWorkflowExecutionCanceledEventAttributes namespaceId.

Implementation of

IChildWorkflowExecutionCanceledEventAttributes.namespaceId


startedEventId

startedEventId: Long

Id of the CHILD_WORKFLOW_EXECUTION_STARTED event which this event corresponds to

Implementation of

IChildWorkflowExecutionCanceledEventAttributes.startedEventId


workflowExecution

Optional workflowExecution: null | IWorkflowExecution

ChildWorkflowExecutionCanceledEventAttributes workflowExecution.

Implementation of

IChildWorkflowExecutionCanceledEventAttributes.workflowExecution


workflowType

Optional workflowType: null | IWorkflowType

ChildWorkflowExecutionCanceledEventAttributes workflowType.

Implementation of

IChildWorkflowExecutionCanceledEventAttributes.workflowType

Methods

toJSON

toJSON(): Object

Converts this ChildWorkflowExecutionCanceledEventAttributes to JSON.

Returns

Object

JSON object


create

create(properties?): ChildWorkflowExecutionCanceledEventAttributes

Creates a new ChildWorkflowExecutionCanceledEventAttributes instance using the specified properties.

Parameters

NameTypeDescription
properties?IChildWorkflowExecutionCanceledEventAttributesProperties to set

Returns

ChildWorkflowExecutionCanceledEventAttributes

ChildWorkflowExecutionCanceledEventAttributes instance


decode

decode(reader, length?): ChildWorkflowExecutionCanceledEventAttributes

Decodes a ChildWorkflowExecutionCanceledEventAttributes message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

ChildWorkflowExecutionCanceledEventAttributes

ChildWorkflowExecutionCanceledEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ChildWorkflowExecutionCanceledEventAttributes

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ChildWorkflowExecutionCanceledEventAttributes

ChildWorkflowExecutionCanceledEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIChildWorkflowExecutionCanceledEventAttributesChildWorkflowExecutionCanceledEventAttributes message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIChildWorkflowExecutionCanceledEventAttributesChildWorkflowExecutionCanceledEventAttributes message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): ChildWorkflowExecutionCanceledEventAttributes

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ChildWorkflowExecutionCanceledEventAttributes

ChildWorkflowExecutionCanceledEventAttributes


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ChildWorkflowExecutionCanceledEventAttributes

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageChildWorkflowExecutionCanceledEventAttributesChildWorkflowExecutionCanceledEventAttributes
options?IConversionOptionsConversion options

Returns

Object

Plain object