Skip to main content

Class: RequestCancelExternalWorkflowExecutionCommandAttributes

command.v1.RequestCancelExternalWorkflowExecutionCommandAttributes

Represents a RequestCancelExternalWorkflowExecutionCommandAttributes.

Implements#

Constructors#

constructor#

new RequestCancelExternalWorkflowExecutionCommandAttributes(properties?)

Constructs a new RequestCancelExternalWorkflowExecutionCommandAttributes.

Parameters#

NameType
properties?IRequestCancelExternalWorkflowExecutionCommandAttributes

Properties#

childWorkflowOnly#

childWorkflowOnly: boolean

RequestCancelExternalWorkflowExecutionCommandAttributes childWorkflowOnly.

Implementation of#

IRequestCancelExternalWorkflowExecutionCommandAttributes.childWorkflowOnly


control#

control: string

RequestCancelExternalWorkflowExecutionCommandAttributes control.

Implementation of#

IRequestCancelExternalWorkflowExecutionCommandAttributes.control


namespace#

namespace: string

RequestCancelExternalWorkflowExecutionCommandAttributes namespace.

Implementation of#

IRequestCancelExternalWorkflowExecutionCommandAttributes.namespace


runId#

runId: string

RequestCancelExternalWorkflowExecutionCommandAttributes runId.

Implementation of#

IRequestCancelExternalWorkflowExecutionCommandAttributes.runId


workflowId#

workflowId: string

RequestCancelExternalWorkflowExecutionCommandAttributes workflowId.

Implementation of#

IRequestCancelExternalWorkflowExecutionCommandAttributes.workflowId

Methods#

toJSON#

toJSON(): Object

Converts this RequestCancelExternalWorkflowExecutionCommandAttributes to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): RequestCancelExternalWorkflowExecutionCommandAttributes

Decodes a RequestCancelExternalWorkflowExecutionCommandAttributes message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

RequestCancelExternalWorkflowExecutionCommandAttributes

RequestCancelExternalWorkflowExecutionCommandAttributes


decodeDelimited#

Static decodeDelimited(reader): RequestCancelExternalWorkflowExecutionCommandAttributes

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

RequestCancelExternalWorkflowExecutionCommandAttributes

RequestCancelExternalWorkflowExecutionCommandAttributes


encode#

Static encode(message, writer?): Writer

Encodes the specified RequestCancelExternalWorkflowExecutionCommandAttributes message. Does not implicitly {@link temporal.api.command.v1.RequestCancelExternalWorkflowExecutionCommandAttributes.verify|verify} messages.

Parameters#

NameTypeDescription
messageIRequestCancelExternalWorkflowExecutionCommandAttributesRequestCancelExternalWorkflowExecutionCommandAttributes message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified RequestCancelExternalWorkflowExecutionCommandAttributes message, length delimited. Does not implicitly {@link temporal.api.command.v1.RequestCancelExternalWorkflowExecutionCommandAttributes.verify|verify} messages.

Parameters#

NameTypeDescription
messageIRequestCancelExternalWorkflowExecutionCommandAttributesRequestCancelExternalWorkflowExecutionCommandAttributes message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): RequestCancelExternalWorkflowExecutionCommandAttributes

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

RequestCancelExternalWorkflowExecutionCommandAttributes

RequestCancelExternalWorkflowExecutionCommandAttributes


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageRequestCancelExternalWorkflowExecutionCommandAttributesRequestCancelExternalWorkflowExecutionCommandAttributes
options?IConversionOptions-

Returns#

Object

Plain object