Class: UpdateWorkerDeploymentVersionMetadataRequest
workflowservice.v1.UpdateWorkerDeploymentVersionMetadataRequest
Used to update the user-defined metadata of a Worker Deployment Version.
Properties
deploymentVersion
• Optional deploymentVersion: null | $Properties
Required.
identity
• identity: string
Optional. The identity of the client who initiated this request.
namespace
• namespace: string
UpdateWorkerDeploymentVersionMetadataRequest namespace.
removeEntries
• removeEntries: string[]
List of keys to remove from the metadata.
upsertEntries
• upsertEntries: Object
UpdateWorkerDeploymentVersionMetadataRequest upsertEntries.
Index signature
▪ [k: string]: $Properties
version
• version: string
Deprecated. Use deployment_version.
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateWorkerDeploymentVersionMetadataRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateWorkerDeploymentVersionMetadataRequest & $Properties
Creates a new UpdateWorkerDeploymentVersionMetadataRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
UpdateWorkerDeploymentVersionMetadataRequest & $Properties
UpdateWorkerDeploymentVersionMetadataRequest instance
▸ create(properties?): UpdateWorkerDeploymentVersionMetadataRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
UpdateWorkerDeploymentVersionMetadataRequest
decode
▸ decode(reader, length?): UpdateWorkerDeploymentVersionMetadataRequest & $Properties
Decodes an UpdateWorkerDeploymentVersionMetadataRequest 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
UpdateWorkerDeploymentVersionMetadataRequest & $Properties
UpdateWorkerDeploymentVersionMetadataRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateWorkerDeploymentVersionMetadataRequest & $Properties
Decodes an UpdateWorkerDeploymentVersionMetadataRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateWorkerDeploymentVersionMetadataRequest & $Properties
UpdateWorkerDeploymentVersionMetadataRequest
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 UpdateWorkerDeploymentVersionMetadataRequest message. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerDeploymentVersionMetadataRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UpdateWorkerDeploymentVersionMetadataRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateWorkerDeploymentVersionMetadataRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerDeploymentVersionMetadataRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UpdateWorkerDeploymentVersionMetadataRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateWorkerDeploymentVersionMetadataRequest
Creates an UpdateWorkerDeploymentVersionMetadataRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateWorkerDeploymentVersionMetadataRequest
UpdateWorkerDeploymentVersionMetadataRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from an UpdateWorkerDeploymentVersionMetadataRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateWorkerDeploymentVersionMetadataRequest | UpdateWorkerDeploymentVersionMetadataRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object