Class: SetWorkerDeploymentRampingVersionResponse
workflowservice.v1.SetWorkerDeploymentRampingVersionResponse
Represents a SetWorkerDeploymentRampingVersionResponse.
Implements
Constructors
constructor
• new SetWorkerDeploymentRampingVersionResponse(properties?): SetWorkerDeploymentRampingVersionResponse
Constructs a new SetWorkerDeploymentRampingVersionResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISetWorkerDeploymentRampingVersionResponse | Properties to set |
Returns
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.
Implementation of
ISetWorkerDeploymentRampingVersionResponse.conflictToken
previousPercentage
• previousPercentage: number
The ramping version percentage before executing this operation.
Implementation of
ISetWorkerDeploymentRampingVersionResponse.previousPercentage
previousVersion
• previousVersion: string
The version that was ramping before executing this operation, in the form
"<deployment_name>.<build_id>". Can also be the __unversioned__ special value.
Implementation of
ISetWorkerDeploymentRampingVersionResponse.previousVersion
Methods
toJSON
▸ toJSON(): Object
Converts this SetWorkerDeploymentRampingVersionResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SetWorkerDeploymentRampingVersionResponse
Creates a new SetWorkerDeploymentRampingVersionResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISetWorkerDeploymentRampingVersionResponse | Properties to set |
Returns
SetWorkerDeploymentRampingVersionResponse
SetWorkerDeploymentRampingVersionResponse instance
decode
▸ decode(reader, length?): SetWorkerDeploymentRampingVersionResponse
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
SetWorkerDeploymentRampingVersionResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SetWorkerDeploymentRampingVersionResponse
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
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 | ISetWorkerDeploymentRampingVersionResponse | 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 | ISetWorkerDeploymentRampingVersionResponse | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for SetWorkerDeploymentRampingVersionResponse
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 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