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