Skip to main content

Interface: IUpdateActivityExecutionOptionsRequest

Properties of an UpdateActivityExecutionOptionsRequest.

Extends​

Properties​

activityId?​

optional activityId?: string | null

The ID of the activity to target.

Inherited from​

$Properties.activityId

activityOptions?​

optional activityOptions?: $Properties | null

Activity options. Partial updates are accepted and controlled by update_mask

Inherited from​

$Properties.activityOptions

identity?​

optional identity?: string | null

The identity of the client who initiated this request

Inherited from​

$Properties.identity

namespace?​

optional namespace?: string | null

Namespace of the workflow which scheduled this activity

Inherited from​

$Properties.namespace

requestId?​

optional requestId?: string | null

Used to de-dupe update requests.

Inherited from​

$Properties.requestId

resourceId?​

optional resourceId?: string | null

Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.

Inherited from​

$Properties.resourceId

restoreOriginal?​

optional restoreOriginal?: boolean | null

If set, the activity options will be restored to the default. Default options are then options activity was created with. They are part of the first schedule event. This flag cannot be combined with any other option; if you supply restore_original together with other options, the request will be rejected.

Inherited from​

$Properties.restoreOriginal

runId?​

optional runId?: string | null

Run ID of the workflow or standalone activity. If empty, targets the latest run.

Inherited from​

$Properties.runId

updateMask?​

optional updateMask?: $Properties | null

Controls which fields from activity_options will be applied

Inherited from​

$Properties.updateMask

workflowId?​

optional workflowId?: string | null

If provided, targets a workflow activity for the given workflow ID. If empty, targets a standalone activity.

Inherited from​

$Properties.workflowId