Class: WorkerDeploymentSummary

v1.ListWorkerDeploymentsResponse.WorkerDeploymentSummary

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

Implements

• IWorkerDeploymentSummary

Constructors

constructor

• new WorkerDeploymentSummary(properties?): WorkerDeploymentSummary

Constructs a new WorkerDeploymentSummary.

Parameters

Name	Type	Description
properties?	IWorkerDeploymentSummary	Properties to set

Returns

WorkerDeploymentSummary

Properties

createTime

• Optional createTime: null | ITimestamp

WorkerDeploymentSummary createTime.

Implementation of

IWorkerDeploymentSummary.createTime

---

currentVersionSummary

• Optional currentVersionSummary: null | IWorkerDeploymentVersionSummary

Summary of the current version of the Worker Deployment.

Implementation of

IWorkerDeploymentSummary.currentVersionSummary

---

latestVersionSummary

• Optional latestVersionSummary: null | IWorkerDeploymentVersionSummary

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

Implementation of

IWorkerDeploymentSummary.latestVersionSummary

---

name

• name: string

WorkerDeploymentSummary name.

Implementation of

IWorkerDeploymentSummary.name

---

rampingVersionSummary

• Optional rampingVersionSummary: null | IWorkerDeploymentVersionSummary

Summary of the ramping version of the Worker Deployment.

Implementation of

IWorkerDeploymentSummary.rampingVersionSummary

---

routingConfig

• Optional routingConfig: null | IRoutingConfig

WorkerDeploymentSummary routingConfig.

Implementation of

IWorkerDeploymentSummary.routingConfig

Methods

toJSON

▸ toJSON(): Object

Converts this WorkerDeploymentSummary to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): WorkerDeploymentSummary

Creates a new WorkerDeploymentSummary instance using the specified properties.

Parameters

Name	Type	Description
properties?	IWorkerDeploymentSummary	Properties to set

Returns

WorkerDeploymentSummary

WorkerDeploymentSummary instance

---

decode

▸ decode(reader, length?): WorkerDeploymentSummary

Decodes a WorkerDeploymentSummary message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

WorkerDeploymentSummary

WorkerDeploymentSummary

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): WorkerDeploymentSummary

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

WorkerDeploymentSummary

WorkerDeploymentSummary

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

Parameters

Name	Type	Description
message	IWorkerDeploymentSummary	WorkerDeploymentSummary message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IWorkerDeploymentSummary	WorkerDeploymentSummary message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): WorkerDeploymentSummary

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

WorkerDeploymentSummary

WorkerDeploymentSummary

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkerDeploymentSummary

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	WorkerDeploymentSummary	WorkerDeploymentSummary
options?	IConversionOptions	Conversion options

Returns

Object

Plain object