Class: UpdateWorkflowExecutionRequest

(-- api-linter: core::0134=disabled aip.dev/not-precedent: Update RPCs don't follow Google API format. --)

Properties

firstExecutionRunId

firstExecutionRunId: string

If set, this call will error if the most recent (if no Run Id is set on workflow_execution), or specified (if it is) Workflow Execution is not part of the same execution chain as this Id.

---

namespace

namespace: string

The namespace name of the target Workflow.

---

request?

optional request?: $Properties | null

The request information that will be delivered all the way down to the Workflow Execution.

---

waitPolicy?

optional waitPolicy?: $Properties | null

Specifies client's intent to wait for Update results. NOTE: This field works together with API call timeout which is limited by server timeout (maximum wait time). If server timeout is expired before user specified timeout, API call returns even if specified stage is not reached. Actual reached stage will be included in the response.

---

workflowExecution?

optional workflowExecution?: $Properties | null

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" --)

Methods

toJSON()

toJSON(): object

Converts this UpdateWorkflowExecutionRequest to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): UpdateWorkflowExecutionRequest & $Shape

Creates a new UpdateWorkflowExecutionRequest instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

UpdateWorkflowExecutionRequest & $Shape

UpdateWorkflowExecutionRequest instance

Call Signature

static create(properties?): UpdateWorkflowExecutionRequest

Creates a new UpdateWorkflowExecutionRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

UpdateWorkflowExecutionRequest

UpdateWorkflowExecutionRequest instance

---

decode()

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

Decodes an UpdateWorkflowExecutionRequest 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

UpdateWorkflowExecutionRequest & $Shape

UpdateWorkflowExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): UpdateWorkflowExecutionRequest & $Shape

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

UpdateWorkflowExecutionRequest & $Shape

UpdateWorkflowExecutionRequest

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

Parameters

message

$Properties

UpdateWorkflowExecutionRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

UpdateWorkflowExecutionRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): UpdateWorkflowExecutionRequest

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

Parameters

object

Plain object

Returns

UpdateWorkflowExecutionRequest

UpdateWorkflowExecutionRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

UpdateWorkflowExecutionRequest

UpdateWorkflowExecutionRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object