Skip to main content

Class: SetWorkerDeploymentManagerRequest

Update the ManagerIdentity of a Worker Deployment.

Properties​

conflictToken​

conflictToken: Uint8Array

Optional. This can be the value of conflict_token from a Describe, or another Worker Deployment API. Passing a non-nil conflict token will cause this request to fail if the Deployment's configuration has been modified between the API call that generated the token and this one.

deploymentName​

deploymentName: string

SetWorkerDeploymentManagerRequest deploymentName.

identity​

identity: string

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

managerIdentity?​

optional managerIdentity?: string | null

Arbitrary value for manager_identity. Empty will unset the field.

namespace​

namespace: string

SetWorkerDeploymentManagerRequest namespace.

newManagerIdentity?​

optional newManagerIdentity?: "managerIdentity" | "self"

SetWorkerDeploymentManagerRequest newManagerIdentity.

self?​

optional self?: boolean | null

True will set manager_identity to identity.

Methods​

toJSON()​

toJSON(): object

Converts this SetWorkerDeploymentManagerRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): SetWorkerDeploymentManagerRequest & $Shape

Creates a new SetWorkerDeploymentManagerRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

SetWorkerDeploymentManagerRequest & $Shape

SetWorkerDeploymentManagerRequest instance

Call Signature​

static create(properties?): SetWorkerDeploymentManagerRequest

Creates a new SetWorkerDeploymentManagerRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SetWorkerDeploymentManagerRequest

SetWorkerDeploymentManagerRequest instance

decode()​

static decode(reader, length?): SetWorkerDeploymentManagerRequest & $Shape

Decodes a SetWorkerDeploymentManagerRequest 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​

SetWorkerDeploymentManagerRequest & $Shape

SetWorkerDeploymentManagerRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SetWorkerDeploymentManagerRequest & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

SetWorkerDeploymentManagerRequest & $Shape

SetWorkerDeploymentManagerRequest

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

Parameters​

message​

$Properties

SetWorkerDeploymentManagerRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

SetWorkerDeploymentManagerRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): SetWorkerDeploymentManagerRequest

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

Parameters​

object​

Plain object

Returns​

SetWorkerDeploymentManagerRequest

SetWorkerDeploymentManagerRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

SetWorkerDeploymentManagerRequest

SetWorkerDeploymentManagerRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object