Skip to main content

Class: UpdateWorkerDeploymentVersionMetadataRequest

Used to update the user-defined metadata of a Worker Deployment Version.

Properties​

deploymentVersion?​

optional deploymentVersion?: $Properties | null

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()​

Call Signature​

static create(properties?): UpdateWorkerDeploymentVersionMetadataRequest & $Properties

Creates a new UpdateWorkerDeploymentVersionMetadataRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateWorkerDeploymentVersionMetadataRequest & $Properties

UpdateWorkerDeploymentVersionMetadataRequest instance

Call Signature​

static create(properties?): UpdateWorkerDeploymentVersionMetadataRequest

Creates a new UpdateWorkerDeploymentVersionMetadataRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateWorkerDeploymentVersionMetadataRequest

UpdateWorkerDeploymentVersionMetadataRequest instance

decode()​

static decode(reader, length?): UpdateWorkerDeploymentVersionMetadataRequest & $Properties

Decodes an UpdateWorkerDeploymentVersionMetadataRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static decodeDelimited(reader): UpdateWorkerDeploymentVersionMetadataRequest & $Properties

Decodes an UpdateWorkerDeploymentVersionMetadataRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static encode(message, writer?): Writer

Encodes the specified UpdateWorkerDeploymentVersionMetadataRequest message. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerDeploymentVersionMetadataRequest.verify|verify messages.

Parameters​

message​

$Properties

UpdateWorkerDeploymentVersionMetadataRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified UpdateWorkerDeploymentVersionMetadataRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerDeploymentVersionMetadataRequest.verify|verify messages.

Parameters​

message​

$Properties

UpdateWorkerDeploymentVersionMetadataRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UpdateWorkerDeploymentVersionMetadataRequest

Creates an UpdateWorkerDeploymentVersionMetadataRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

UpdateWorkerDeploymentVersionMetadataRequest

UpdateWorkerDeploymentVersionMetadataRequest

toObject()​

static toObject(message, options?): object

Creates a plain object from an UpdateWorkerDeploymentVersionMetadataRequest message. Also converts values to other types if specified.

Parameters​

message​

UpdateWorkerDeploymentVersionMetadataRequest

UpdateWorkerDeploymentVersionMetadataRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object