Skip to main content

Interface: $Properties

v1.StartActivityExecutionRequest.$Properties

Properties of a StartActivityExecutionRequest.

Hierarchy​

Properties​

activityId​

• Optional activityId: null | string

Identifier for this activity. Required. This identifier should be meaningful in the user's own system. It must be unique among activities in the same namespace, subject to the rules imposed by id_reuse_policy and id_conflict_policy.

activityType​

• Optional activityType: null | $Properties

The type of the activity, a string that corresponds to a registered activity on a worker.

completionCallbacks​

• Optional completionCallbacks: null | $Properties[]

Callbacks to be called by the server when this activity reaches a terminal state. Callback addresses must be whitelisted in the server's dynamic configuration.

• Optional header: null | $Properties

Header for context propagation and tracing purposes.

heartbeatTimeout​

• Optional heartbeatTimeout: null | $Properties

Maximum permitted time between successful worker heartbeats.

idConflictPolicy​

• Optional idConflictPolicy: null | ActivityIdConflictPolicy

Defines how to resolve an activity id conflict with a running activity. The default policy is ACTIVITY_ID_CONFLICT_POLICY_FAIL.

idReusePolicy​

• Optional idReusePolicy: null | ActivityIdReusePolicy

Defines whether to allow re-using the activity id from a previously closed activity. The default policy is ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE.

identity​

• Optional identity: null | string

The identity of the client who initiated this request

input​

• Optional input: null | $Properties

Serialized arguments to the activity. These are passed as arguments to the activity function.

• Optional links: null | $Properties[]

Links to be associated with the activity. Callbacks may also have associated links; links already included with a callback should not be duplicated here.

namespace​

• Optional namespace: null | string

StartActivityExecutionRequest namespace

onConflictOptions​

• Optional onConflictOptions: null | $Properties

Options for handling conflicts when using ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING.

priority​

• Optional priority: null | $Properties

Priority metadata.

requestId​

• Optional requestId: null | string

A unique identifier for this start request. Typically UUIDv4.

retryPolicy​

• Optional retryPolicy: null | $Properties

The retry policy for the activity. Will never exceed schedule_to_close_timeout.

scheduleToCloseTimeout​

• Optional scheduleToCloseTimeout: null | $Properties

Indicates how long the caller is willing to wait for an activity completion. Limits how long retries will be attempted. Either this or start_to_close_timeout must be specified.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

scheduleToStartTimeout​

• Optional scheduleToStartTimeout: null | $Properties

Limits time an activity task can stay in a task queue before a worker picks it up. This timeout is always non retryable, as all a retry would achieve is to put it back into the same queue. Defaults to schedule_to_close_timeout if not specified.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

searchAttributes​

• Optional searchAttributes: null | $Properties

Search attributes for indexing.

startDelay​

• Optional startDelay: null | $Properties

Time to wait before making the first activity task available for dispatch. This delay is not applied to retry attempts.

startToCloseTimeout​

• Optional startToCloseTimeout: null | $Properties

Maximum time an activity is allowed to execute after being picked up by a worker. This timeout is always retryable. Either this or schedule_to_close_timeout must be specified.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

taskQueue​

• Optional taskQueue: null | $Properties

Task queue to schedule this activity on.

userMetadata​

• Optional userMetadata: null | $Properties

Metadata for use by user interfaces to display the fixed as-of-start summary and details of the activity.