Skip to main content

Class: UpdateWorkflowExecutionOptionsRequest

workflowservice.v1.UpdateWorkflowExecutionOptionsRequest

Represents an UpdateWorkflowExecutionOptionsRequest.

Implements

Constructors

constructor

new UpdateWorkflowExecutionOptionsRequest(properties?): UpdateWorkflowExecutionOptionsRequest

Constructs a new UpdateWorkflowExecutionOptionsRequest.

Parameters

NameTypeDescription
properties?IUpdateWorkflowExecutionOptionsRequestProperties to set

Returns

UpdateWorkflowExecutionOptionsRequest

Properties

namespace

namespace: string

The namespace name of the target Workflow.

Implementation of

IUpdateWorkflowExecutionOptionsRequest.namespace


updateMask

Optional updateMask: null | IFieldMask

Controls which fields from workflow_execution_options will be applied. To unset a field, set it to null and use the update mask to indicate that it should be mutated.

Implementation of

IUpdateWorkflowExecutionOptionsRequest.updateMask


workflowExecution

Optional workflowExecution: null | IWorkflowExecution

The target Workflow Id and (optionally) a specific Run Id thereof. (-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: false positive triggered by the word "optional" --)

Implementation of

IUpdateWorkflowExecutionOptionsRequest.workflowExecution


workflowExecutionOptions

Optional workflowExecutionOptions: null | IWorkflowExecutionOptions

Workflow Execution options. Partial updates are accepted and controlled by update_mask.

Implementation of

IUpdateWorkflowExecutionOptionsRequest.workflowExecutionOptions

Methods

toJSON

toJSON(): Object

Converts this UpdateWorkflowExecutionOptionsRequest to JSON.

Returns

Object

JSON object


create

create(properties?): UpdateWorkflowExecutionOptionsRequest

Creates a new UpdateWorkflowExecutionOptionsRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IUpdateWorkflowExecutionOptionsRequestProperties to set

Returns

UpdateWorkflowExecutionOptionsRequest

UpdateWorkflowExecutionOptionsRequest instance


decode

decode(reader, length?): UpdateWorkflowExecutionOptionsRequest

Decodes an UpdateWorkflowExecutionOptionsRequest message from the specified reader or buffer.

Parameters

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

Returns

UpdateWorkflowExecutionOptionsRequest

UpdateWorkflowExecutionOptionsRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): UpdateWorkflowExecutionOptionsRequest

Decodes an UpdateWorkflowExecutionOptionsRequest message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

UpdateWorkflowExecutionOptionsRequest

UpdateWorkflowExecutionOptionsRequest

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): UpdateWorkflowExecutionOptionsRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

UpdateWorkflowExecutionOptionsRequest

UpdateWorkflowExecutionOptionsRequest


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for UpdateWorkflowExecutionOptionsRequest

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

Parameters

NameTypeDescription
messageUpdateWorkflowExecutionOptionsRequestUpdateWorkflowExecutionOptionsRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object