Class: SetWorkerDeploymentRampingVersionResponse
workflowservice.v1.SetWorkerDeploymentRampingVersionResponse
Represents a SetWorkerDeploymentRampingVersionResponse.
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 ramping before executing this operation.
Deprecated in favor of idempotency of the API. Use DescribeWorkerDeployment to get the
Ramping 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.
previousPercentage
• previousPercentage: number
The ramping version percentage before executing this operation.
Deprecated in favor of idempotency of the API. Use DescribeWorkerDeployment to get the
Ramping 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 SetWorkerDeploymentRampingVersionResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SetWorkerDeploymentRampingVersionResponse & $Properties
Creates a new SetWorkerDeploymentRampingVersionResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
SetWorkerDeploymentRampingVersionResponse & $Properties
SetWorkerDeploymentRampingVersionResponse instance
▸ create(properties?): SetWorkerDeploymentRampingVersionResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
SetWorkerDeploymentRampingVersionResponse
decode
▸ decode(reader, length?): SetWorkerDeploymentRampingVersionResponse & $Properties
Decodes a SetWorkerDeploymentRampingVersionResponse 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
SetWorkerDeploymentRampingVersionResponse & $Properties
SetWorkerDeploymentRampingVersionResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SetWorkerDeploymentRampingVersionResponse & $Properties
Decodes a SetWorkerDeploymentRampingVersionResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SetWorkerDeploymentRampingVersionResponse & $Properties
SetWorkerDeploymentRampingVersionResponse
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 SetWorkerDeploymentRampingVersionResponse message. Does not implicitly temporal.api.workflowservice.v1.SetWorkerDeploymentRampingVersionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | SetWorkerDeploymentRampingVersionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified SetWorkerDeploymentRampingVersionResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.SetWorkerDeploymentRampingVersionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | SetWorkerDeploymentRampingVersionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SetWorkerDeploymentRampingVersionResponse
Creates a SetWorkerDeploymentRampingVersionResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SetWorkerDeploymentRampingVersionResponse
SetWorkerDeploymentRampingVersionResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from a SetWorkerDeploymentRampingVersionResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SetWorkerDeploymentRampingVersionResponse | SetWorkerDeploymentRampingVersionResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object