Class: WorkerVersionStamp
Identifies the version(s) of a worker that processed a task
Implements
Constructors
constructor
• new WorkerVersionStamp(properties?): WorkerVersionStamp
Constructs a new WorkerVersionStamp.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkerVersionStamp | Properties to set |
Returns
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.
Implementation of
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.
Implementation of
IWorkerVersionStamp.useVersioning
Methods
toJSON
▸ toJSON(): Object
Converts this WorkerVersionStamp to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkerVersionStamp
Creates a new WorkerVersionStamp instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkerVersionStamp | Properties to set |
Returns
WorkerVersionStamp instance
decode
▸ decode(reader, length?): WorkerVersionStamp
Decodes a WorkerVersionStamp 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
WorkerVersionStamp
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkerVersionStamp
Decodes a WorkerVersionStamp message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkerVersionStamp
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 WorkerVersionStamp message. Does not implicitly temporal.api.common.v1.WorkerVersionStamp.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkerVersionStamp | WorkerVersionStamp message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkerVersionStamp message, length delimited. Does not implicitly temporal.api.common.v1.WorkerVersionStamp.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkerVersionStamp | WorkerVersionStamp message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkerVersionStamp
Creates a WorkerVersionStamp message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkerVersionStamp
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkerVersionStamp
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 a WorkerVersionStamp message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkerVersionStamp | WorkerVersionStamp |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object