Class: ActivityExecutionInfo

activity.v1.ActivityExecutionInfo

Information about a standalone activity.

Implements

• IActivityExecutionInfo

Constructors

constructor

• new ActivityExecutionInfo(properties?): ActivityExecutionInfo

Constructs a new ActivityExecutionInfo.

Parameters

Name	Type	Description
properties?	IActivityExecutionInfo	Properties to set

Returns

ActivityExecutionInfo

Properties

activityId

• activityId: string

Unique identifier of this activity within its namespace along with run ID (below).

Implementation of

IActivityExecutionInfo.activityId

---

activityType

• Optional activityType: null | IActivityType

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

Implementation of

IActivityExecutionInfo.activityType

---

attempt

• attempt: number

The attempt this activity is currently on. Incremented each time a new attempt is scheduled.

Implementation of

IActivityExecutionInfo.attempt

---

canceledReason

• canceledReason: string

Set if activity cancelation was requested.

Implementation of

IActivityExecutionInfo.canceledReason

---

closeTime

• Optional closeTime: null | ITimestamp

Time when the activity transitioned to a closed state.

Implementation of

IActivityExecutionInfo.closeTime

---

currentRetryInterval

• Optional currentRetryInterval: null | IDuration

Time from the last attempt failure to the next activity retry. If the activity is currently running, this represents the next retry interval in case the attempt fails. If activity is currently backing off between attempt, this represents the current retry interval. If there is no next retry allowed, this field will be null. This interval is typically calculated from the specified retry policy, but may be modified if an activity fails with a retryable application failure specifying a retry delay.

Implementation of

IActivityExecutionInfo.currentRetryInterval

---

executionDuration

• Optional executionDuration: null | IDuration

How long this activity has been running for, including all attempts and backoff between attempts.

Implementation of

IActivityExecutionInfo.executionDuration

---

expirationTime

• Optional expirationTime: null | ITimestamp

Scheduled time + schedule to close timeout.

Implementation of

IActivityExecutionInfo.expirationTime

---

header

• Optional header: null | IHeader

ActivityExecutionInfo header.

Implementation of

IActivityExecutionInfo.header

---

heartbeatDetails

• Optional heartbeatDetails: null | IPayloads

Details provided in the last recorded activity heartbeat.

Implementation of

IActivityExecutionInfo.heartbeatDetails

---

heartbeatTimeout

• Optional heartbeatTimeout: null | IDuration

Maximum permitted time between successful worker heartbeats.

Implementation of

IActivityExecutionInfo.heartbeatTimeout

---

lastAttemptCompleteTime

• Optional lastAttemptCompleteTime: null | ITimestamp

The time when the last activity attempt completed. If activity has not been completed yet, it will be null.

Implementation of

IActivityExecutionInfo.lastAttemptCompleteTime

---

lastDeploymentVersion

• Optional lastDeploymentVersion: null | IWorkerDeploymentVersion

The Worker Deployment Version this activity was dispatched to most recently. If nil, the activity has not yet been dispatched or was last dispatched to an unversioned worker.

Implementation of

IActivityExecutionInfo.lastDeploymentVersion

---

lastFailure

• Optional lastFailure: null | IFailure

Failure details from the last failed attempt.

Implementation of

IActivityExecutionInfo.lastFailure

---

lastHeartbeatTime

• Optional lastHeartbeatTime: null | ITimestamp

Time the last heartbeat was recorded.

Implementation of

IActivityExecutionInfo.lastHeartbeatTime

---

lastStartedTime

• Optional lastStartedTime: null | ITimestamp

Time the last attempt was started.

Implementation of

IActivityExecutionInfo.lastStartedTime

---

lastWorkerIdentity

• lastWorkerIdentity: string

ActivityExecutionInfo lastWorkerIdentity.

Implementation of

IActivityExecutionInfo.lastWorkerIdentity

---

nextAttemptScheduleTime

• Optional nextAttemptScheduleTime: null | ITimestamp

The time when the next activity attempt will be scheduled. If activity is currently scheduled or started, this field will be null.

Implementation of

IActivityExecutionInfo.nextAttemptScheduleTime

---

priority

• Optional priority: null | IPriority

Priority metadata.

Implementation of

IActivityExecutionInfo.priority

---

retryPolicy

• Optional retryPolicy: null | IRetryPolicy

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

Implementation of

IActivityExecutionInfo.retryPolicy

---

runId

• runId: string

ActivityExecutionInfo runId.

Implementation of

IActivityExecutionInfo.runId

---

runState

• runState: PendingActivityState

More detailed breakdown of ACTIVITY_EXECUTION_STATUS_RUNNING.

Implementation of

IActivityExecutionInfo.runState

---

scheduleTime

• Optional scheduleTime: null | ITimestamp

Time the activity was originally scheduled via a StartActivityExecution request.

Implementation of

IActivityExecutionInfo.scheduleTime

---

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.

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

Implementation of

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

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

Implementation of

IActivityExecutionInfo.scheduleToStartTimeout

---

searchAttributes

• Optional searchAttributes: null | ISearchAttributes

ActivityExecutionInfo searchAttributes.

Implementation of

IActivityExecutionInfo.searchAttributes

---

startToCloseTimeout

• Optional startToCloseTimeout: null | IDuration

Maximum time a single activity attempt is allowed to execute after being picked up by a worker. This timeout is always retryable.

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

Implementation of

IActivityExecutionInfo.startToCloseTimeout

---

stateSizeBytes

• stateSizeBytes: Long

Updated once on scheduled and once on terminal status.

Implementation of

IActivityExecutionInfo.stateSizeBytes

---

stateTransitionCount

• stateTransitionCount: Long

Incremented each time the activity's state is mutated in persistence.

Implementation of

IActivityExecutionInfo.stateTransitionCount

---

status

• status: ActivityExecutionStatus

A general status for this activity, indicates whether it is currently running or in one of the terminal statuses.

Implementation of

IActivityExecutionInfo.status

---

taskQueue

• taskQueue: string

ActivityExecutionInfo taskQueue.

Implementation of

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

IActivityExecutionInfo.userMetadata

Methods

toJSON

▸ toJSON(): Object

Converts this ActivityExecutionInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): ActivityExecutionInfo

Creates a new ActivityExecutionInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	IActivityExecutionInfo	Properties to set

Returns

ActivityExecutionInfo

ActivityExecutionInfo instance

---

decode

▸ decode(reader, length?): ActivityExecutionInfo

Decodes an ActivityExecutionInfo 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

ActivityExecutionInfo

ActivityExecutionInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): ActivityExecutionInfo

Decodes an ActivityExecutionInfo message from the specified reader or buffer, length delimited.

Parameters

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

Returns

ActivityExecutionInfo

ActivityExecutionInfo

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 ActivityExecutionInfo message. Does not implicitly temporal.api.activity.v1.ActivityExecutionInfo.verify|verify messages.

Parameters

Name	Type	Description
message	IActivityExecutionInfo	ActivityExecutionInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IActivityExecutionInfo	ActivityExecutionInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): ActivityExecutionInfo

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

ActivityExecutionInfo

ActivityExecutionInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ActivityExecutionInfo

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 an ActivityExecutionInfo message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	ActivityExecutionInfo	ActivityExecutionInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object