Class: DeploymentInfo
deployment.v1.DeploymentInfo
DeploymentInfo holds information about a deployment. Deployment information is tracked
automatically by server as soon as the first poll from that deployment reaches the server. There
can be multiple task queue workers in a single deployment which are listed in this message.
Implements
Constructors
constructor
• new DeploymentInfo(properties?): DeploymentInfo
Constructs a new DeploymentInfo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeploymentInfo | Properties to set |
Returns
Properties
createTime
• Optional createTime: null | ITimestamp
DeploymentInfo createTime.
Implementation of
deployment
• Optional deployment: null | IDeployment
DeploymentInfo deployment.
Implementation of
isCurrent
• isCurrent: boolean
If this deployment is the current deployment of its deployment series.
Implementation of
metadata
• metadata: Object
A user-defined set of key-values. Can be updated as part of write operations to the
deployment, such as SetCurrentDeployment.
Index signature
▪ [k: string]: IPayload
Implementation of
taskQueueInfos
• taskQueueInfos: ITaskQueueInfo[]
DeploymentInfo taskQueueInfos.
Implementation of
IDeploymentInfo.taskQueueInfos
Methods
toJSON
▸ toJSON(): Object
Converts this DeploymentInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DeploymentInfo
Creates a new DeploymentInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeploymentInfo | Properties to set |
Returns
DeploymentInfo instance
decode
▸ decode(reader, length?): DeploymentInfo
Decodes a DeploymentInfo 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
DeploymentInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DeploymentInfo
Decodes a DeploymentInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DeploymentInfo
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 DeploymentInfo message. Does not implicitly temporal.api.deployment.v1.DeploymentInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDeploymentInfo | DeploymentInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DeploymentInfo message, length delimited. Does not implicitly temporal.api.deployment.v1.DeploymentInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDeploymentInfo | DeploymentInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DeploymentInfo
Creates a DeploymentInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DeploymentInfo
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for DeploymentInfo
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 DeploymentInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DeploymentInfo | DeploymentInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object