Skip to main content

Interface: $Properties

Properties of an UpdateActivityExecutionOptionsRequest.

Extended by​

Properties​

activityId?​

optional activityId?: string | null

The ID of the activity to target.

activityOptions?​

optional activityOptions?: $Properties | null

Activity options. Partial updates are accepted and controlled by update_mask

identity?​

optional identity?: string | null

The identity of the client who initiated this request

namespace?​

optional namespace?: string | null

Namespace of the workflow which scheduled this activity

requestId?​

optional requestId?: string | null

Used to de-dupe update requests.

resourceId?​

optional resourceId?: string | null

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

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.

runId?​

optional runId?: string | null

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

updateMask?​

optional updateMask?: $Properties | null

Controls which fields from activity_options will be applied

workflowId?​

optional workflowId?: string | null

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