Class: SetWorkerDeploymentCurrentVersionResponse
workflowservice.v1.SetWorkerDeploymentCurrentVersionResponse
Represents a SetWorkerDeploymentCurrentVersionResponse.
Properties
conflictToken
• conflictToken: Uint8Array
This value is returned so that it can be optionally passed to APIs that write to the Worker Deployment state to ensure that the state did not change between this API call and a future write.
previousDeploymentVersion
• Optional previousDeploymentVersion: null | $Properties
The version that was current before executing this operation.
Deprecated in favor of idempotency of the API. Use DescribeWorkerDeployment to get the
Current version info before calling this API. By passing the conflict_token got from the
DescribeWorkerDeployment call to this API you can ensure there is no interfering changes
between the two calls.
previousVersion
• previousVersion: string
Deprecated. Use previous_deployment_version.
Methods
toJSON
▸ toJSON(): Object
Converts this SetWorkerDeploymentCurrentVersionResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SetWorkerDeploymentCurrentVersionResponse & $Properties
Creates a new SetWorkerDeploymentCurrentVersionResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
SetWorkerDeploymentCurrentVersionResponse & $Properties
SetWorkerDeploymentCurrentVersionResponse instance
▸ create(properties?): SetWorkerDeploymentCurrentVersionResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
SetWorkerDeploymentCurrentVersionResponse
decode
▸ decode(reader, length?): SetWorkerDeploymentCurrentVersionResponse & $Properties
Decodes a SetWorkerDeploymentCurrentVersionResponse 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
SetWorkerDeploymentCurrentVersionResponse & $Properties
SetWorkerDeploymentCurrentVersionResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SetWorkerDeploymentCurrentVersionResponse & $Properties
Decodes a SetWorkerDeploymentCurrentVersionResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SetWorkerDeploymentCurrentVersionResponse & $Properties
SetWorkerDeploymentCurrentVersionResponse
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 SetWorkerDeploymentCurrentVersionResponse message. Does not implicitly temporal.api.workflowservice.v1.SetWorkerDeploymentCurrentVersionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | SetWorkerDeploymentCurrentVersionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified SetWorkerDeploymentCurrentVersionResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.SetWorkerDeploymentCurrentVersionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | SetWorkerDeploymentCurrentVersionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SetWorkerDeploymentCurrentVersionResponse
Creates a SetWorkerDeploymentCurrentVersionResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SetWorkerDeploymentCurrentVersionResponse
SetWorkerDeploymentCurrentVersionResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from a SetWorkerDeploymentCurrentVersionResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SetWorkerDeploymentCurrentVersionResponse | SetWorkerDeploymentCurrentVersionResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object