Class: StartActivityExecutionRequest

workflowservice.v1.StartActivityExecutionRequest

Represents a StartActivityExecutionRequest.

Implements

• IStartActivityExecutionRequest

Constructors

constructor

• new StartActivityExecutionRequest(properties?): StartActivityExecutionRequest

Constructs a new StartActivityExecutionRequest.

Parameters

Name	Type	Description
properties?	IStartActivityExecutionRequest	Properties to set

Returns

StartActivityExecutionRequest

Properties

activityId

• activityId: 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.

Implementation of

IStartActivityExecutionRequest.activityId

---

activityType

• Optional activityType: null | IActivityType

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

Implementation of

IStartActivityExecutionRequest.activityType

---

header

• Optional header: null | IHeader

Header for context propagation and tracing purposes.

Implementation of

IStartActivityExecutionRequest.header

---

heartbeatTimeout

• Optional heartbeatTimeout: null | IDuration

Maximum permitted time between successful worker heartbeats.

Implementation of

IStartActivityExecutionRequest.heartbeatTimeout

---

idConflictPolicy

• idConflictPolicy: ActivityIdConflictPolicy

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

Implementation of

IStartActivityExecutionRequest.idConflictPolicy

---

idReusePolicy

• idReusePolicy: 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.

Implementation of

IStartActivityExecutionRequest.idReusePolicy

---

identity

• identity: string

The identity of the client who initiated this request

Implementation of

IStartActivityExecutionRequest.identity

---

input

• Optional input: null | IPayloads

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

Implementation of

IStartActivityExecutionRequest.input

---

namespace

• namespace: string

StartActivityExecutionRequest namespace.

Implementation of

IStartActivityExecutionRequest.namespace

---

priority

• Optional priority: null | IPriority

Priority metadata.

Implementation of

IStartActivityExecutionRequest.priority

---

requestId

• requestId: string

A unique identifier for this start request. Typically UUIDv4.

Implementation of

IStartActivityExecutionRequest.requestId

---

retryPolicy

• Optional retryPolicy: null | IRetryPolicy

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

Implementation of

IStartActivityExecutionRequest.retryPolicy

---

scheduleToCloseTimeout

• Optional scheduleToCloseTimeout: null | IDuration

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

Implementation of

IStartActivityExecutionRequest.scheduleToCloseTimeout

---

scheduleToStartTimeout

• Optional scheduleToStartTimeout: null | IDuration

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

Implementation of

IStartActivityExecutionRequest.scheduleToStartTimeout

---

searchAttributes

• Optional searchAttributes: null | ISearchAttributes

Search attributes for indexing.

Implementation of

IStartActivityExecutionRequest.searchAttributes

---

startToCloseTimeout

• Optional startToCloseTimeout: null | IDuration

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

Implementation of

IStartActivityExecutionRequest.startToCloseTimeout

---

taskQueue

• Optional taskQueue: null | ITaskQueue

Task queue to schedule this activity on.

Implementation of

IStartActivityExecutionRequest.taskQueue

---

userMetadata

• Optional userMetadata: null | IUserMetadata

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

Implementation of

IStartActivityExecutionRequest.userMetadata

Methods

toJSON

▸ toJSON(): Object

Converts this StartActivityExecutionRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): StartActivityExecutionRequest

Creates a new StartActivityExecutionRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IStartActivityExecutionRequest	Properties to set

Returns

StartActivityExecutionRequest

StartActivityExecutionRequest instance

---

decode

▸ decode(reader, length?): StartActivityExecutionRequest

Decodes a StartActivityExecutionRequest message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

StartActivityExecutionRequest

StartActivityExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): StartActivityExecutionRequest

Decodes a StartActivityExecutionRequest message from the specified reader or buffer, length delimited.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

StartActivityExecutionRequest

StartActivityExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

Encodes the specified StartActivityExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.StartActivityExecutionRequest.verify|verify messages.

Parameters

Name	Type	Description
message	IStartActivityExecutionRequest	StartActivityExecutionRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

Encodes the specified StartActivityExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.StartActivityExecutionRequest.verify|verify messages.

Parameters

Name	Type	Description
message	IStartActivityExecutionRequest	StartActivityExecutionRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): StartActivityExecutionRequest

Creates a StartActivityExecutionRequest message from a plain object. Also converts values to their respective internal types.

Parameters

Name	Type	Description
object	Object	Plain object

Returns

StartActivityExecutionRequest

StartActivityExecutionRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for StartActivityExecutionRequest

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

Creates a plain object from a StartActivityExecutionRequest message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	StartActivityExecutionRequest	StartActivityExecutionRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object