Skip to main content

Class: ResetPointInfo

workflow.v1.ResetPointInfo

ResetPointInfo records the workflow event id that is the first one processed by a given build id or binary checksum. A new reset point will be created if either build id or binary checksum changes (although in general only one or the other will be used at a time).

Implements

Constructors

constructor

new ResetPointInfo(properties?): ResetPointInfo

Constructs a new ResetPointInfo.

Parameters

NameTypeDescription
properties?IResetPointInfoProperties to set

Returns

ResetPointInfo

Properties

binaryChecksum

binaryChecksum: string

A worker binary version identifier (deprecated).

Implementation of

IResetPointInfo.binaryChecksum


buildId

buildId: string

Worker build id.

Implementation of

IResetPointInfo.buildId


createTime

Optional createTime: null | ITimestamp

ResetPointInfo createTime.

Implementation of

IResetPointInfo.createTime


expireTime

Optional expireTime: null | ITimestamp

(-- api-linter: core::0214::resource-expiry=disabled aip.dev/not-precedent: TTL is not defined for ResetPointInfo. --) The time that the run is deleted due to retention.

Implementation of

IResetPointInfo.expireTime


firstWorkflowTaskCompletedId

firstWorkflowTaskCompletedId: Long

Event ID of the first WorkflowTaskCompleted event processed by this worker build.

Implementation of

IResetPointInfo.firstWorkflowTaskCompletedId


resettable

resettable: boolean

false if the reset point has pending childWFs/reqCancels/signalExternals.

Implementation of

IResetPointInfo.resettable


runId

runId: string

The first run ID in the execution chain that was touched by this worker build.

Implementation of

IResetPointInfo.runId

Methods

toJSON

toJSON(): Object

Converts this ResetPointInfo to JSON.

Returns

Object

JSON object


create

create(properties?): ResetPointInfo

Creates a new ResetPointInfo instance using the specified properties.

Parameters

NameTypeDescription
properties?IResetPointInfoProperties to set

Returns

ResetPointInfo

ResetPointInfo instance


decode

decode(reader, length?): ResetPointInfo

Decodes a ResetPointInfo message from the specified reader or buffer.

Parameters

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

Returns

ResetPointInfo

ResetPointInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ResetPointInfo

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ResetPointInfo

ResetPointInfo

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): ResetPointInfo

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ResetPointInfo

ResetPointInfo


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ResetPointInfo

Parameters

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

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageResetPointInfoResetPointInfo
options?IConversionOptionsConversion options

Returns

Object

Plain object