Skip to main content

Class: PendingActivityInfo

workflow.v1.PendingActivityInfo

Represents a PendingActivityInfo.

Implements

Constructors

constructor

new PendingActivityInfo(properties?)

Constructs a new PendingActivityInfo.

Parameters

NameTypeDescription
properties?IPendingActivityInfoProperties to set

Properties

activityId

activityId: string

PendingActivityInfo activityId.

Implementation of

IPendingActivityInfo.activityId


activityType

Optional activityType: null | IActivityType

PendingActivityInfo activityType.

Implementation of

IPendingActivityInfo.activityType


attempt

attempt: number

PendingActivityInfo attempt.

Implementation of

IPendingActivityInfo.attempt


expirationTime

Optional expirationTime: null | ITimestamp

PendingActivityInfo expirationTime.

Implementation of

IPendingActivityInfo.expirationTime


heartbeatDetails

Optional heartbeatDetails: null | IPayloads

PendingActivityInfo heartbeatDetails.

Implementation of

IPendingActivityInfo.heartbeatDetails


lastFailure

Optional lastFailure: null | IFailure

PendingActivityInfo lastFailure.

Implementation of

IPendingActivityInfo.lastFailure


lastHeartbeatTime

Optional lastHeartbeatTime: null | ITimestamp

PendingActivityInfo lastHeartbeatTime.

Implementation of

IPendingActivityInfo.lastHeartbeatTime


lastStartedTime

Optional lastStartedTime: null | ITimestamp

PendingActivityInfo lastStartedTime.

Implementation of

IPendingActivityInfo.lastStartedTime


lastWorkerIdentity

lastWorkerIdentity: string

PendingActivityInfo lastWorkerIdentity.

Implementation of

IPendingActivityInfo.lastWorkerIdentity


maximumAttempts

maximumAttempts: number

PendingActivityInfo maximumAttempts.

Implementation of

IPendingActivityInfo.maximumAttempts


scheduledTime

Optional scheduledTime: null | ITimestamp

PendingActivityInfo scheduledTime.

Implementation of

IPendingActivityInfo.scheduledTime


state

state: PendingActivityState

PendingActivityInfo state.

Implementation of

IPendingActivityInfo.state

Methods

toJSON

toJSON(): Object

Converts this PendingActivityInfo to JSON.

Returns

Object

JSON object


create

Static create(properties?): PendingActivityInfo

Creates a new PendingActivityInfo instance using the specified properties.

Parameters

NameTypeDescription
properties?IPendingActivityInfoProperties to set

Returns

PendingActivityInfo

PendingActivityInfo instance


decode

Static decode(reader, length?): PendingActivityInfo

Decodes a PendingActivityInfo message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

PendingActivityInfo

PendingActivityInfo


decodeDelimited

Static decodeDelimited(reader): PendingActivityInfo

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

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

PendingActivityInfo

PendingActivityInfo


encode

Static encode(message, writer?): Writer

Encodes the specified PendingActivityInfo message. Does not implicitly temporal.api.workflow.v1.PendingActivityInfo.verify|verify messages.

Parameters

NameTypeDescription
messageIPendingActivityInfoPendingActivityInfo message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIPendingActivityInfoPendingActivityInfo message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

Static fromObject(object): PendingActivityInfo

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

PendingActivityInfo

PendingActivityInfo


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PendingActivityInfo

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

Static toObject(message, options?): Object

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

Parameters

NameTypeDescription
messagePendingActivityInfoPendingActivityInfo
options?IConversionOptionsConversion options

Returns

Object

Plain object