Class: WorkerVersionCapabilities
Identifies the version that a worker is compatible with when polling or identifying itself, and whether or not this worker is opting into the build-id based versioning feature. This is used by matching to determine which workers ought to receive what tasks. Deprecated. Use WorkerDeploymentOptions instead.
Properties
buildId
buildId:
string
An opaque whole-worker identifier
deploymentSeriesName
deploymentSeriesName:
string
Must be sent if user has set a deployment series name (versioning-3).
useVersioning
useVersioning:
boolean
If set, the worker is opting in to worker versioning, and wishes to only receive appropriate tasks.
Methods
toJSON()
toJSON():
object
Converts this WorkerVersionCapabilities to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):WorkerVersionCapabilities&$Properties
Creates a new WorkerVersionCapabilities instance using the specified properties.
Parameters
properties?
Properties to set
Returns
WorkerVersionCapabilities & $Properties
WorkerVersionCapabilities instance
Call Signature
staticcreate(properties?):WorkerVersionCapabilities
Creates a new WorkerVersionCapabilities instance using the specified properties.
Parameters
properties?
Properties to set
Returns
WorkerVersionCapabilities
WorkerVersionCapabilities instance
decode()
staticdecode(reader,length?):WorkerVersionCapabilities&$Properties
Decodes a WorkerVersionCapabilities 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
WorkerVersionCapabilities & $Properties
WorkerVersionCapabilities
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):WorkerVersionCapabilities&$Properties
Decodes a WorkerVersionCapabilities message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
WorkerVersionCapabilities & $Properties
WorkerVersionCapabilities
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified WorkerVersionCapabilities message. Does not implicitly temporal.api.common.v1.WorkerVersionCapabilities.verify|verify messages.
Parameters
message
WorkerVersionCapabilities message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified WorkerVersionCapabilities message, length delimited. Does not implicitly temporal.api.common.v1.WorkerVersionCapabilities.verify|verify messages.
Parameters
message
WorkerVersionCapabilities message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):WorkerVersionCapabilities
Creates a WorkerVersionCapabilities message from a plain object. Also converts values to their respective internal types.
Parameters
object
{[k: string]: any; }
Plain object
Returns
WorkerVersionCapabilities
WorkerVersionCapabilities
toObject()
statictoObject(message,options?):object
Creates a plain object from a WorkerVersionCapabilities message. Also converts values to other types if specified.
Parameters
message
WorkerVersionCapabilities
WorkerVersionCapabilities
options?
IConversionOptions
Conversion options
Returns
object
Plain object