Skip to main content

Class: SetCurrentDeploymentRequest

workflowservice.v1.SetCurrentDeploymentRequest

Represents a SetCurrentDeploymentRequest.

Implements

Constructors

constructor

new SetCurrentDeploymentRequest(properties?): SetCurrentDeploymentRequest

Constructs a new SetCurrentDeploymentRequest.

Parameters

NameTypeDescription
properties?ISetCurrentDeploymentRequestProperties to set

Returns

SetCurrentDeploymentRequest

Properties

deployment

Optional deployment: null | IDeployment

SetCurrentDeploymentRequest deployment.

Implementation of

ISetCurrentDeploymentRequest.deployment


identity

identity: string

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

Implementation of

ISetCurrentDeploymentRequest.identity


namespace

namespace: string

SetCurrentDeploymentRequest namespace.

Implementation of

ISetCurrentDeploymentRequest.namespace


updateMetadata

Optional updateMetadata: null | IUpdateDeploymentMetadata

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.

Implementation of

ISetCurrentDeploymentRequest.updateMetadata

Methods

toJSON

toJSON(): Object

Converts this SetCurrentDeploymentRequest to JSON.

Returns

Object

JSON object


create

create(properties?): SetCurrentDeploymentRequest

Creates a new SetCurrentDeploymentRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?ISetCurrentDeploymentRequestProperties to set

Returns

SetCurrentDeploymentRequest

SetCurrentDeploymentRequest instance


decode

decode(reader, length?): SetCurrentDeploymentRequest

Decodes a SetCurrentDeploymentRequest message from the specified reader or buffer.

Parameters

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

Returns

SetCurrentDeploymentRequest

SetCurrentDeploymentRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): SetCurrentDeploymentRequest

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

SetCurrentDeploymentRequest

SetCurrentDeploymentRequest

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

Parameters

NameTypeDescription
messageISetCurrentDeploymentRequestSetCurrentDeploymentRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageISetCurrentDeploymentRequestSetCurrentDeploymentRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): SetCurrentDeploymentRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

SetCurrentDeploymentRequest

SetCurrentDeploymentRequest


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for SetCurrentDeploymentRequest

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 a SetCurrentDeploymentRequest message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageSetCurrentDeploymentRequestSetCurrentDeploymentRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object