Skip to main content

Interface: IUpdateActivityOptionsRequest

Properties of an UpdateActivityOptionsRequest.

Extends​

Properties​

activity?​

optional activity?: "id" | "type" | "matchAll"

either activity id, activity type or update_all must be provided

Inherited from​

$Properties.activity

activityOptions?​

optional activityOptions?: $Properties | null

Activity options. Partial updates are accepted and controlled by update_mask

Inherited from​

$Properties.activityOptions

execution?​

optional execution?: $Properties | null

Execution info of the workflow which scheduled this activity

Inherited from​

$Properties.execution

id?​

optional id?: string | null

Only activity with this ID will be updated.

Inherited from​

$Properties.id

identity?​

optional identity?: string | null

The identity of the client who initiated this request

Inherited from​

$Properties.identity

matchAll?​

optional matchAll?: boolean | null

Update all running activities.

Inherited from​

$Properties.matchAll

namespace?​

optional namespace?: string | null

Namespace of the workflow which scheduled this activity

Inherited from​

$Properties.namespace

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

type?​

optional type?: string | null

Update all running activities of this type.

Inherited from​

$Properties.type

updateMask?​

optional updateMask?: $Properties | null

Controls which fields from activity_options will be applied

Inherited from​

$Properties.updateMask