Skip to main content

Class: WorkerVersionStamp

Deprecated. This message is replaced with Deployment and VersioningBehavior. Identifies the version(s) of a worker that processed a task

Properties​

buildId​

buildId: string

An opaque whole-worker identifier. Replaces the deprecated binary_checksum field when this message is included in requests which previously used that.

useVersioning​

useVersioning: boolean

If set, the worker is opting in to worker versioning. Otherwise, this is used only as a marker for workflow reset points and the BuildIDs search attribute.

Methods​

toJSON()​

toJSON(): object

Converts this WorkerVersionStamp to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkerVersionStamp & $Properties

Creates a new WorkerVersionStamp instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerVersionStamp & $Properties

WorkerVersionStamp instance

Call Signature​

static create(properties?): WorkerVersionStamp

Creates a new WorkerVersionStamp instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerVersionStamp

WorkerVersionStamp instance

decode()​

static decode(reader, length?): WorkerVersionStamp & $Properties

Decodes a WorkerVersionStamp message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

WorkerVersionStamp & $Properties

WorkerVersionStamp

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkerVersionStamp & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkerVersionStamp & $Properties

WorkerVersionStamp

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified WorkerVersionStamp message. Does not implicitly temporal.api.common.v1.WorkerVersionStamp.verify|verify messages.

Parameters​

message​

$Properties

WorkerVersionStamp message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkerVersionStamp message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkerVersionStamp

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

WorkerVersionStamp

WorkerVersionStamp

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkerVersionStamp

WorkerVersionStamp

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object