Skip to main content

Class: UpdateWorkerDeploymentVersionMetadataRequest

workflowservice.v1.UpdateWorkerDeploymentVersionMetadataRequest

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

Implements

Constructors

constructor

new UpdateWorkerDeploymentVersionMetadataRequest(properties?): UpdateWorkerDeploymentVersionMetadataRequest

Constructs a new UpdateWorkerDeploymentVersionMetadataRequest.

Parameters

NameTypeDescription
properties?IUpdateWorkerDeploymentVersionMetadataRequestProperties to set

Returns

UpdateWorkerDeploymentVersionMetadataRequest

Properties

namespace

namespace: string

UpdateWorkerDeploymentVersionMetadataRequest namespace.

Implementation of

IUpdateWorkerDeploymentVersionMetadataRequest.namespace


removeEntries

removeEntries: string[]

List of keys to remove from the metadata.

Implementation of

IUpdateWorkerDeploymentVersionMetadataRequest.removeEntries


upsertEntries

upsertEntries: Object

UpdateWorkerDeploymentVersionMetadataRequest upsertEntries.

Index signature

▪ [k: string]: IPayload

Implementation of

IUpdateWorkerDeploymentVersionMetadataRequest.upsertEntries


version

version: string

Deployment Version identifier in the form "<deployment_name>.<build_id>".

Implementation of

IUpdateWorkerDeploymentVersionMetadataRequest.version

Methods

toJSON

toJSON(): Object

Converts this UpdateWorkerDeploymentVersionMetadataRequest to JSON.

Returns

Object

JSON object


create

create(properties?): UpdateWorkerDeploymentVersionMetadataRequest

Creates a new UpdateWorkerDeploymentVersionMetadataRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IUpdateWorkerDeploymentVersionMetadataRequestProperties to set

Returns

UpdateWorkerDeploymentVersionMetadataRequest

UpdateWorkerDeploymentVersionMetadataRequest instance


decode

decode(reader, length?): UpdateWorkerDeploymentVersionMetadataRequest

Decodes an UpdateWorkerDeploymentVersionMetadataRequest message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

UpdateWorkerDeploymentVersionMetadataRequest

UpdateWorkerDeploymentVersionMetadataRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): UpdateWorkerDeploymentVersionMetadataRequest

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

UpdateWorkerDeploymentVersionMetadataRequest

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

NameTypeDescription
messageIUpdateWorkerDeploymentVersionMetadataRequestUpdateWorkerDeploymentVersionMetadataRequest message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
messageIUpdateWorkerDeploymentVersionMetadataRequestUpdateWorkerDeploymentVersionMetadataRequest message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

UpdateWorkerDeploymentVersionMetadataRequest

UpdateWorkerDeploymentVersionMetadataRequest


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for UpdateWorkerDeploymentVersionMetadataRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageUpdateWorkerDeploymentVersionMetadataRequestUpdateWorkerDeploymentVersionMetadataRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object