Class: UpdateWorkerDeploymentVersionComputeConfigRequest
workflowservice.v1.UpdateWorkerDeploymentVersionComputeConfigRequest
Used to update the compute config of a Worker Deployment Version.
Properties
computeConfigScalingGroups
• computeConfigScalingGroups: Object
Optional. Contains the compute config scaling groups to add or update for the Worker Deployment.
Index signature
▪ [k: string]: $Properties
deploymentVersion
• Optional deploymentVersion: null | $Properties
Required.
identity
• identity: string
Optional. The identity of the client who initiated this request.
namespace
• namespace: string
UpdateWorkerDeploymentVersionComputeConfigRequest namespace.
removeComputeConfigScalingGroups
• removeComputeConfigScalingGroups: string[]
Optional. Contains the compute config scaling groups to remove from the Worker Deployment.
requestId
• requestId: string
A unique identifier for this create request for idempotence. Typically UUIDv4. If a second request with the same ID is recieved, it is considered a successful no-op. Retrying with a different request ID for the same deployment name + build ID is an error.
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateWorkerDeploymentVersionComputeConfigRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateWorkerDeploymentVersionComputeConfigRequest & $Properties
Creates a new UpdateWorkerDeploymentVersionComputeConfigRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
UpdateWorkerDeploymentVersionComputeConfigRequest & $Properties
UpdateWorkerDeploymentVersionComputeConfigRequest instance
▸ create(properties?): UpdateWorkerDeploymentVersionComputeConfigRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
UpdateWorkerDeploymentVersionComputeConfigRequest
decode
▸ decode(reader, length?): UpdateWorkerDeploymentVersionComputeConfigRequest & $Properties
Decodes an UpdateWorkerDeploymentVersionComputeConfigRequest 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
UpdateWorkerDeploymentVersionComputeConfigRequest & $Properties
UpdateWorkerDeploymentVersionComputeConfigRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateWorkerDeploymentVersionComputeConfigRequest & $Properties
Decodes an UpdateWorkerDeploymentVersionComputeConfigRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateWorkerDeploymentVersionComputeConfigRequest & $Properties
UpdateWorkerDeploymentVersionComputeConfigRequest
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 UpdateWorkerDeploymentVersionComputeConfigRequest message. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerDeploymentVersionComputeConfigRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UpdateWorkerDeploymentVersionComputeConfigRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateWorkerDeploymentVersionComputeConfigRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerDeploymentVersionComputeConfigRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UpdateWorkerDeploymentVersionComputeConfigRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateWorkerDeploymentVersionComputeConfigRequest
Creates an UpdateWorkerDeploymentVersionComputeConfigRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateWorkerDeploymentVersionComputeConfigRequest
UpdateWorkerDeploymentVersionComputeConfigRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from an UpdateWorkerDeploymentVersionComputeConfigRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateWorkerDeploymentVersionComputeConfigRequest | UpdateWorkerDeploymentVersionComputeConfigRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object