Skip to main content

Class: RequestCancelExternalWorkflowExecutionFailedEventAttributes

history.v1.RequestCancelExternalWorkflowExecutionFailedEventAttributes

Represents a RequestCancelExternalWorkflowExecutionFailedEventAttributes.

Implements

Constructors

constructor

new RequestCancelExternalWorkflowExecutionFailedEventAttributes(properties?): RequestCancelExternalWorkflowExecutionFailedEventAttributes

Constructs a new RequestCancelExternalWorkflowExecutionFailedEventAttributes.

Parameters

NameTypeDescription
properties?IRequestCancelExternalWorkflowExecutionFailedEventAttributesProperties to set

Returns

RequestCancelExternalWorkflowExecutionFailedEventAttributes

Properties

cause

cause: CancelExternalWorkflowExecutionFailedCause

RequestCancelExternalWorkflowExecutionFailedEventAttributes cause.

Implementation of

IRequestCancelExternalWorkflowExecutionFailedEventAttributes.cause


control

control: string

Deprecated

Implementation of

IRequestCancelExternalWorkflowExecutionFailedEventAttributes.control


initiatedEventId

initiatedEventId: Long

id of the REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED event this failure corresponds to

Implementation of

IRequestCancelExternalWorkflowExecutionFailedEventAttributes.initiatedEventId


namespace

namespace: string

Namespace of the workflow which failed to cancel. SDKs and UI tools should use namespace field but server must use namespace_id only.

Implementation of

IRequestCancelExternalWorkflowExecutionFailedEventAttributes.namespace


namespaceId

namespaceId: string

RequestCancelExternalWorkflowExecutionFailedEventAttributes namespaceId.

Implementation of

IRequestCancelExternalWorkflowExecutionFailedEventAttributes.namespaceId


workflowExecution

Optional workflowExecution: null | IWorkflowExecution

RequestCancelExternalWorkflowExecutionFailedEventAttributes workflowExecution.

Implementation of

IRequestCancelExternalWorkflowExecutionFailedEventAttributes.workflowExecution


workflowTaskCompletedEventId

workflowTaskCompletedEventId: Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

Implementation of

IRequestCancelExternalWorkflowExecutionFailedEventAttributes.workflowTaskCompletedEventId

Methods

toJSON

toJSON(): Object

Converts this RequestCancelExternalWorkflowExecutionFailedEventAttributes to JSON.

Returns

Object

JSON object


create

create(properties?): RequestCancelExternalWorkflowExecutionFailedEventAttributes

Creates a new RequestCancelExternalWorkflowExecutionFailedEventAttributes instance using the specified properties.

Parameters

NameTypeDescription
properties?IRequestCancelExternalWorkflowExecutionFailedEventAttributesProperties to set

Returns

RequestCancelExternalWorkflowExecutionFailedEventAttributes

RequestCancelExternalWorkflowExecutionFailedEventAttributes instance


decode

decode(reader, length?): RequestCancelExternalWorkflowExecutionFailedEventAttributes

Decodes a RequestCancelExternalWorkflowExecutionFailedEventAttributes message from the specified reader or buffer.

Parameters

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

Returns

RequestCancelExternalWorkflowExecutionFailedEventAttributes

RequestCancelExternalWorkflowExecutionFailedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): RequestCancelExternalWorkflowExecutionFailedEventAttributes

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

RequestCancelExternalWorkflowExecutionFailedEventAttributes

RequestCancelExternalWorkflowExecutionFailedEventAttributes

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): RequestCancelExternalWorkflowExecutionFailedEventAttributes

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

RequestCancelExternalWorkflowExecutionFailedEventAttributes

RequestCancelExternalWorkflowExecutionFailedEventAttributes


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for RequestCancelExternalWorkflowExecutionFailedEventAttributes

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 RequestCancelExternalWorkflowExecutionFailedEventAttributes message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageRequestCancelExternalWorkflowExecutionFailedEventAttributesRequestCancelExternalWorkflowExecutionFailedEventAttributes
options?IConversionOptionsConversion options

Returns

Object

Plain object