Class: SetCurrentDeploymentRequest

[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later

Properties

deployment?

optional deployment?: $Properties | null

SetCurrentDeploymentRequest deployment.

---

identity

identity: string

Optional. The identity of the client who initiated this request.

---

namespace

namespace: string

SetCurrentDeploymentRequest namespace.

---

updateMetadata?

optional updateMetadata?: $Properties | null

Optional. Use to add or remove user-defined metadata entries. Metadata entries are exposed when describing a deployment. It is a good place for information such as operator name, links to internal deployment pipelines, etc.

Methods

toJSON()

toJSON(): object

Converts this SetCurrentDeploymentRequest to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): SetCurrentDeploymentRequest & $Properties

Creates a new SetCurrentDeploymentRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

SetCurrentDeploymentRequest & $Properties

SetCurrentDeploymentRequest instance

Call Signature

static create(properties?): SetCurrentDeploymentRequest

Creates a new SetCurrentDeploymentRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

SetCurrentDeploymentRequest

SetCurrentDeploymentRequest instance

---

decode()

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

Decodes a SetCurrentDeploymentRequest 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

SetCurrentDeploymentRequest & $Properties

SetCurrentDeploymentRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): SetCurrentDeploymentRequest & $Properties

Decodes a SetCurrentDeploymentRequest message from the specified reader or buffer, length delimited.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

SetCurrentDeploymentRequest & $Properties

SetCurrentDeploymentRequest

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

Parameters

message

$Properties

SetCurrentDeploymentRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

SetCurrentDeploymentRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): SetCurrentDeploymentRequest

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

Parameters

object

Plain object

Returns

SetCurrentDeploymentRequest

SetCurrentDeploymentRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

SetCurrentDeploymentRequest

SetCurrentDeploymentRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object