Class: WorkerVersionCapabilities
common.v1.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.
Implements
Constructors
constructor
• new WorkerVersionCapabilities(properties?): WorkerVersionCapabilities
Constructs a new WorkerVersionCapabilities.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkerVersionCapabilities | Properties to set |
Returns
Properties
buildId
• buildId: string
An opaque whole-worker identifier
Implementation of
IWorkerVersionCapabilities.buildId
deploymentSeriesName
• deploymentSeriesName: string
Must be sent if user has set a deployment series name (versioning-3).
Implementation of
IWorkerVersionCapabilities.deploymentSeriesName
useVersioning
• useVersioning: boolean
If set, the worker is opting in to worker versioning, and wishes to only receive appropriate tasks.
Implementation of
IWorkerVersionCapabilities.useVersioning
Methods
toJSON
▸ toJSON(): Object
Converts this WorkerVersionCapabilities to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkerVersionCapabilities
Creates a new WorkerVersionCapabilities instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkerVersionCapabilities | Properties to set |
Returns
WorkerVersionCapabilities instance
decode
▸ decode(reader, length?): WorkerVersionCapabilities
Decodes a WorkerVersionCapabilities 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
WorkerVersionCapabilities
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkerVersionCapabilities
Decodes a WorkerVersionCapabilities message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkerVersionCapabilities
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 WorkerVersionCapabilities message. Does not implicitly temporal.api.common.v1.WorkerVersionCapabilities.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkerVersionCapabilities | WorkerVersionCapabilities message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkerVersionCapabilities message, length delimited. Does not implicitly temporal.api.common.v1.WorkerVersionCapabilities.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkerVersionCapabilities | WorkerVersionCapabilities message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkerVersionCapabilities
Creates a WorkerVersionCapabilities message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkerVersionCapabilities
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkerVersionCapabilities
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 WorkerVersionCapabilities message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkerVersionCapabilities | WorkerVersionCapabilities |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object