Class: ActivityExecutionListInfo

activity.v1.ActivityExecutionListInfo

Limited activity information returned in the list response. When adding fields here, ensure that it is also present in ActivityExecutionInfo (note that it may already be present in ActivityExecutionInfo but not at the top-level).

Implements

• IActivityExecutionListInfo

Constructors

constructor

• new ActivityExecutionListInfo(properties?): ActivityExecutionListInfo

Constructs a new ActivityExecutionListInfo.

Parameters

Name	Type	Description
properties?	IActivityExecutionListInfo	Properties to set

Returns

ActivityExecutionListInfo

Properties

activityId

• activityId: string

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

Implementation of

IActivityExecutionListInfo.activityId

---

activityType

• Optional activityType: null | IActivityType

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

Implementation of

IActivityExecutionListInfo.activityType

---

closeTime

• Optional closeTime: null | ITimestamp

If the activity is in a terminal status, this field represents the time the activity transitioned to that status.

Implementation of

IActivityExecutionListInfo.closeTime

---

executionDuration

• Optional executionDuration: null | IDuration

The difference between close time and scheduled time. This field is only populated if the activity is closed.

Implementation of

IActivityExecutionListInfo.executionDuration

---

runId

• runId: string

The run ID of the standalone activity.

Implementation of

IActivityExecutionListInfo.runId

---

scheduleTime

• Optional scheduleTime: null | ITimestamp

Time the activity was originally scheduled via a StartActivityExecution request.

Implementation of

IActivityExecutionListInfo.scheduleTime

---

searchAttributes

• Optional searchAttributes: null | ISearchAttributes

Search attributes from the start request.

Implementation of

IActivityExecutionListInfo.searchAttributes

---

stateSizeBytes

• stateSizeBytes: Long

Updated once on scheduled and once on terminal status.

Implementation of

IActivityExecutionListInfo.stateSizeBytes

---

stateTransitionCount

• stateTransitionCount: Long

Updated on terminal status.

Implementation of

IActivityExecutionListInfo.stateTransitionCount

---

status

• status: ActivityExecutionStatus

Only scheduled and terminal statuses appear here. More detailed information in PendingActivityInfo but not available in the list response.

Implementation of

IActivityExecutionListInfo.status

---

taskQueue

• taskQueue: string

The task queue this activity was scheduled on when it was originally started, updated on activity options update.

Implementation of

IActivityExecutionListInfo.taskQueue

Methods

toJSON

▸ toJSON(): Object

Converts this ActivityExecutionListInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): ActivityExecutionListInfo

Creates a new ActivityExecutionListInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	IActivityExecutionListInfo	Properties to set

Returns

ActivityExecutionListInfo

ActivityExecutionListInfo instance

---

decode

▸ decode(reader, length?): ActivityExecutionListInfo

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

ActivityExecutionListInfo

ActivityExecutionListInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): ActivityExecutionListInfo

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

Parameters

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

Returns

ActivityExecutionListInfo

ActivityExecutionListInfo

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

Parameters

Name	Type	Description
message	IActivityExecutionListInfo	ActivityExecutionListInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IActivityExecutionListInfo	ActivityExecutionListInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): ActivityExecutionListInfo

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

ActivityExecutionListInfo

ActivityExecutionListInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ActivityExecutionListInfo

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

Parameters

Name	Type	Description
message	ActivityExecutionListInfo	ActivityExecutionListInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object