Skip to main content

Class: UpdateDeploymentMetadata

Used as part of Deployment write APIs to update metadata attached to a deployment. Deprecated.

Properties​

removeEntries​

removeEntries: string[]

List of keys to remove from the metadata.

upsertEntries​

upsertEntries: object

UpdateDeploymentMetadata upsertEntries.

Index Signature​

[k: string]: $Properties

Methods​

toJSON()​

toJSON(): object

Converts this UpdateDeploymentMetadata to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): UpdateDeploymentMetadata & $Properties

Creates a new UpdateDeploymentMetadata instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateDeploymentMetadata & $Properties

UpdateDeploymentMetadata instance

Call Signature​

static create(properties?): UpdateDeploymentMetadata

Creates a new UpdateDeploymentMetadata instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateDeploymentMetadata

UpdateDeploymentMetadata instance

decode()​

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

Decodes an UpdateDeploymentMetadata 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​

UpdateDeploymentMetadata & $Properties

UpdateDeploymentMetadata

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): UpdateDeploymentMetadata & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UpdateDeploymentMetadata & $Properties

UpdateDeploymentMetadata

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 UpdateDeploymentMetadata message. Does not implicitly temporal.api.deployment.v1.UpdateDeploymentMetadata.verify|verify messages.

Parameters​

message​

$Properties

UpdateDeploymentMetadata message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

UpdateDeploymentMetadata message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UpdateDeploymentMetadata

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

Parameters​

object​

Plain object

Returns​

UpdateDeploymentMetadata

UpdateDeploymentMetadata

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

UpdateDeploymentMetadata

UpdateDeploymentMetadata

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object