Skip to main content

Class: WorkerDeploymentSummary

(-- api-linter: core::0123::resource-annotation=disabled --) A subset of WorkerDeploymentInfo

Properties​

createTime?​

optional createTime?: $Properties | null

WorkerDeploymentSummary createTime.

currentVersionSummary?​

optional currentVersionSummary?: $Properties | null

Summary of the current version of the Worker Deployment.

latestVersionSummary?​

optional latestVersionSummary?: $Properties | null

Summary of the version that was added most recently in the Worker Deployment.

name​

name: string

WorkerDeploymentSummary name.

rampingVersionSummary?​

optional rampingVersionSummary?: $Properties | null

Summary of the ramping version of the Worker Deployment.

routingConfig?​

optional routingConfig?: $Properties | null

WorkerDeploymentSummary routingConfig.

Methods​

toJSON()​

toJSON(): object

Converts this WorkerDeploymentSummary to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkerDeploymentSummary & $Properties

Creates a new WorkerDeploymentSummary instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerDeploymentSummary & $Properties

WorkerDeploymentSummary instance

Call Signature​

static create(properties?): WorkerDeploymentSummary

Creates a new WorkerDeploymentSummary instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerDeploymentSummary

WorkerDeploymentSummary instance

decode()​

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

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

WorkerDeploymentSummary & $Properties

WorkerDeploymentSummary

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkerDeploymentSummary & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkerDeploymentSummary & $Properties

WorkerDeploymentSummary

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

Parameters​

message​

$Properties

WorkerDeploymentSummary message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkerDeploymentSummary message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkerDeploymentSummary

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

Parameters​

object​

Plain object

Returns​

WorkerDeploymentSummary

WorkerDeploymentSummary

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkerDeploymentSummary

WorkerDeploymentSummary

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object