Class: WorkerDeploymentVersionSummary
v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary
Represents a WorkerDeploymentVersionSummary.
Implements
Constructors
constructor
• new WorkerDeploymentVersionSummary(properties?): WorkerDeploymentVersionSummary
Constructs a new WorkerDeploymentVersionSummary.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkerDeploymentVersionSummary | Properties to set |
Returns
WorkerDeploymentVersionSummary
Properties
createTime
• Optional createTime: null | ITimestamp
WorkerDeploymentVersionSummary createTime.
Implementation of
IWorkerDeploymentVersionSummary.createTime
drainageStatus
• drainageStatus: VersionDrainageStatus
WorkerDeploymentVersionSummary drainageStatus.
Implementation of
IWorkerDeploymentVersionSummary.drainageStatus
version
• version: string
The fully-qualified string representation of the version, in the form "<deployment_name>.<build_id>".
Implementation of
IWorkerDeploymentVersionSummary.version
Methods
toJSON
▸ toJSON(): Object
Converts this WorkerDeploymentVersionSummary to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkerDeploymentVersionSummary
Creates a new WorkerDeploymentVersionSummary instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkerDeploymentVersionSummary | Properties to set |
Returns
WorkerDeploymentVersionSummary
WorkerDeploymentVersionSummary instance
decode
▸ decode(reader, length?): WorkerDeploymentVersionSummary
Decodes a WorkerDeploymentVersionSummary 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
WorkerDeploymentVersionSummary
WorkerDeploymentVersionSummary
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkerDeploymentVersionSummary
Decodes a WorkerDeploymentVersionSummary message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkerDeploymentVersionSummary
WorkerDeploymentVersionSummary
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 WorkerDeploymentVersionSummary message. Does not implicitly temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkerDeploymentVersionSummary | WorkerDeploymentVersionSummary message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkerDeploymentVersionSummary message, length delimited. Does not implicitly temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkerDeploymentVersionSummary | WorkerDeploymentVersionSummary message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkerDeploymentVersionSummary
Creates a WorkerDeploymentVersionSummary message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkerDeploymentVersionSummary
WorkerDeploymentVersionSummary
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkerDeploymentVersionSummary
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 WorkerDeploymentVersionSummary message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkerDeploymentVersionSummary | WorkerDeploymentVersionSummary |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object