Skip to main content

Interface: $Properties

Properties of an UpdateWorkflowExecutionRequest.

Extended by​

Properties​

firstExecutionRunId?​

optional firstExecutionRunId?: string | null

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?​

optional namespace?: string | null

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