Skip to main content

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

Properties​

activityId​

• activityId: string

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


activityType​

• Optional activityType: null | $Properties

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


closeTime​

• Optional closeTime: null | $Properties

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


executionDuration​

• Optional executionDuration: null | $Properties

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


executionTime​

• Optional executionTime: null | $Properties

The time at which the first activity task is made available for dispatch, computed as schedule_time + start_delay. Same as schedule_time if start_delay is not set.


runId​

• runId: string

The run ID of the standalone activity.


scheduleTime​

• Optional scheduleTime: null | $Properties

Time the activity was originally scheduled via a StartActivityExecution request.


searchAttributes​

• Optional searchAttributes: null | $Properties

Search attributes from the start request.


stateSizeBytes​

• stateSizeBytes: Long

Updated once on scheduled and once on terminal status.


stateTransitionCount​

• stateTransitionCount: Long

Updated on terminal status.


status​

• status: ActivityExecutionStatus

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


taskQueue​

• taskQueue: string

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

Methods​

toJSON​

▸ toJSON(): Object

Converts this ActivityExecutionListInfo to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): ActivityExecutionListInfo & $Properties

Creates a new ActivityExecutionListInfo instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

ActivityExecutionListInfo & $Properties

ActivityExecutionListInfo instance

▸ create(properties?): ActivityExecutionListInfo

Parameters​

NameType
properties?$Properties

Returns​

ActivityExecutionListInfo


decode​

▸ decode(reader, length?): ActivityExecutionListInfo & $Properties

Decodes an ActivityExecutionListInfo message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

ActivityExecutionListInfo & $Properties

ActivityExecutionListInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): ActivityExecutionListInfo & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

ActivityExecutionListInfo & $Properties

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​

NameTypeDescription
message$PropertiesActivityExecutionListInfo message or plain object to encode
writer?WriterWriter 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​

NameTypeDescription
message$PropertiesActivityExecutionListInfo message or plain object to encode
writer?WriterWriter 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​

NameTypeDescription
objectObjectPlain object

Returns​

ActivityExecutionListInfo

ActivityExecutionListInfo


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageActivityExecutionListInfoActivityExecutionListInfo
options?IConversionOptionsConversion options

Returns​

Object

Plain object