Skip to main content

Class: RequestCancelWorkflowExecutionRequest

workflowservice.v1.RequestCancelWorkflowExecutionRequest

Represents a RequestCancelWorkflowExecutionRequest.

Implements

Constructors

constructor

new RequestCancelWorkflowExecutionRequest(properties?)

Constructs a new RequestCancelWorkflowExecutionRequest.

Parameters

NameTypeDescription
properties?IRequestCancelWorkflowExecutionRequestProperties to set

Properties

firstExecutionRunId

firstExecutionRunId: string

RequestCancelWorkflowExecutionRequest firstExecutionRunId.

Implementation of

IRequestCancelWorkflowExecutionRequest.firstExecutionRunId


identity

identity: string

RequestCancelWorkflowExecutionRequest identity.

Implementation of

IRequestCancelWorkflowExecutionRequest.identity


namespace

namespace: string

RequestCancelWorkflowExecutionRequest namespace.

Implementation of

IRequestCancelWorkflowExecutionRequest.namespace


reason

reason: string

RequestCancelWorkflowExecutionRequest reason.

Implementation of

IRequestCancelWorkflowExecutionRequest.reason


requestId

requestId: string

RequestCancelWorkflowExecutionRequest requestId.

Implementation of

IRequestCancelWorkflowExecutionRequest.requestId


workflowExecution

Optional workflowExecution: null | IWorkflowExecution

RequestCancelWorkflowExecutionRequest workflowExecution.

Implementation of

IRequestCancelWorkflowExecutionRequest.workflowExecution

Methods

toJSON

toJSON(): Object

Converts this RequestCancelWorkflowExecutionRequest to JSON.

Returns

Object

JSON object


create

Static create(properties?): RequestCancelWorkflowExecutionRequest

Creates a new RequestCancelWorkflowExecutionRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IRequestCancelWorkflowExecutionRequestProperties to set

Returns

RequestCancelWorkflowExecutionRequest

RequestCancelWorkflowExecutionRequest instance


decode

Static decode(reader, length?): RequestCancelWorkflowExecutionRequest

Decodes a RequestCancelWorkflowExecutionRequest message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

RequestCancelWorkflowExecutionRequest

RequestCancelWorkflowExecutionRequest


decodeDelimited

Static decodeDelimited(reader): RequestCancelWorkflowExecutionRequest

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

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

RequestCancelWorkflowExecutionRequest

RequestCancelWorkflowExecutionRequest


encode

Static encode(message, writer?): Writer

Encodes the specified RequestCancelWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.RequestCancelWorkflowExecutionRequest.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

Static fromObject(object): RequestCancelWorkflowExecutionRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

RequestCancelWorkflowExecutionRequest

RequestCancelWorkflowExecutionRequest


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for RequestCancelWorkflowExecutionRequest

Parameters

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

Returns

string

The default type url


toObject

Static toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageRequestCancelWorkflowExecutionRequestRequestCancelWorkflowExecutionRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object