Skip to main content

Class: UpdateWorkflowOptions

UpdateWorkflowOptions represents updating workflow execution options after a workflow reset. Keep the parameters in sync with temporal.api.workflowservice.v1.UpdateWorkflowExecutionOptionsRequest.

Properties​

updateMask?​

optional updateMask?: $Properties | null

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.

workflowExecutionOptions?​

optional workflowExecutionOptions?: $Properties | null

Update Workflow options that were originally specified via StartWorkflowExecution. Partial updates are accepted and controlled by update_mask.

Methods​

toJSON()​

toJSON(): object

Converts this UpdateWorkflowOptions to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): UpdateWorkflowOptions & $Shape

Creates a new UpdateWorkflowOptions instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

UpdateWorkflowOptions & $Shape

UpdateWorkflowOptions instance

Call Signature​

static create(properties?): UpdateWorkflowOptions

Creates a new UpdateWorkflowOptions instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateWorkflowOptions

UpdateWorkflowOptions instance

decode()​

static decode(reader, length?): UpdateWorkflowOptions & $Shape

Decodes an UpdateWorkflowOptions message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

UpdateWorkflowOptions & $Shape

UpdateWorkflowOptions

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): UpdateWorkflowOptions & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UpdateWorkflowOptions & $Shape

UpdateWorkflowOptions

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified UpdateWorkflowOptions message. Does not implicitly temporal.api.workflow.v1.PostResetOperation.UpdateWorkflowOptions.verify|verify messages.

Parameters​

message​

$Properties

UpdateWorkflowOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified UpdateWorkflowOptions message, length delimited. Does not implicitly temporal.api.workflow.v1.PostResetOperation.UpdateWorkflowOptions.verify|verify messages.

Parameters​

message​

$Properties

UpdateWorkflowOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UpdateWorkflowOptions

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

UpdateWorkflowOptions

UpdateWorkflowOptions

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

UpdateWorkflowOptions

UpdateWorkflowOptions

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object