Skip to main content

Class: SetWorkerDeploymentCurrentVersionResponse

Represents a SetWorkerDeploymentCurrentVersionResponse.

Properties​

conflictToken​

conflictToken: Uint8Array

This value is returned so that it can be optionally passed to APIs that write to the Worker Deployment state to ensure that the state did not change between this API call and a future write.


previousDeploymentVersion?​

optional previousDeploymentVersion?: $Properties | null

The version that was current before executing this operation. Deprecated in favor of idempotency of the API. Use DescribeWorkerDeployment to get the Current version info before calling this API. By passing the conflict_token got from the DescribeWorkerDeployment call to this API you can ensure there is no interfering changes between the two calls.


previousVersion​

previousVersion: string

Deprecated. Use previous_deployment_version.

Methods​

toJSON()​

toJSON(): object

Converts this SetWorkerDeploymentCurrentVersionResponse to JSON.

Returns​

object

JSON object


create()​

Call Signature​

static create(properties?): SetWorkerDeploymentCurrentVersionResponse & $Properties

Creates a new SetWorkerDeploymentCurrentVersionResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SetWorkerDeploymentCurrentVersionResponse & $Properties

SetWorkerDeploymentCurrentVersionResponse instance

Call Signature​

static create(properties?): SetWorkerDeploymentCurrentVersionResponse

Creates a new SetWorkerDeploymentCurrentVersionResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SetWorkerDeploymentCurrentVersionResponse

SetWorkerDeploymentCurrentVersionResponse instance


decode()​

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

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

SetWorkerDeploymentCurrentVersionResponse & $Properties

SetWorkerDeploymentCurrentVersionResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): SetWorkerDeploymentCurrentVersionResponse & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

SetWorkerDeploymentCurrentVersionResponse & $Properties

SetWorkerDeploymentCurrentVersionResponse

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

Parameters​

message​

$Properties

SetWorkerDeploymentCurrentVersionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

SetWorkerDeploymentCurrentVersionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): SetWorkerDeploymentCurrentVersionResponse

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

Parameters​

object​

Plain object

Returns​

SetWorkerDeploymentCurrentVersionResponse

SetWorkerDeploymentCurrentVersionResponse


toObject()​

static toObject(message, options?): object

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

Parameters​

message​

SetWorkerDeploymentCurrentVersionResponse

SetWorkerDeploymentCurrentVersionResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object