Class: DeploymentListInfo
deployment.v1.DeploymentListInfo
DeploymentListInfo is an abbreviated set of fields from DeploymentInfo that's returned in ListDeployments.
Implements
Constructors
constructor
• new DeploymentListInfo(properties?): DeploymentListInfo
Constructs a new DeploymentListInfo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeploymentListInfo | Properties to set |
Returns
Properties
createTime
• Optional createTime: null | ITimestamp
DeploymentListInfo createTime.
Implementation of
IDeploymentListInfo.createTime
deployment
• Optional deployment: null | IDeployment
DeploymentListInfo deployment.
Implementation of
IDeploymentListInfo.deployment
isCurrent
• isCurrent: boolean
If this deployment is the current deployment of its deployment series.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this DeploymentListInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DeploymentListInfo
Creates a new DeploymentListInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeploymentListInfo | Properties to set |
Returns
DeploymentListInfo instance
decode
▸ decode(reader, length?): DeploymentListInfo
Decodes a DeploymentListInfo 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
DeploymentListInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DeploymentListInfo
Decodes a DeploymentListInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DeploymentListInfo
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 DeploymentListInfo message. Does not implicitly temporal.api.deployment.v1.DeploymentListInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDeploymentListInfo | DeploymentListInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DeploymentListInfo message, length delimited. Does not implicitly temporal.api.deployment.v1.DeploymentListInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDeploymentListInfo | DeploymentListInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DeploymentListInfo
Creates a DeploymentListInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DeploymentListInfo
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for DeploymentListInfo
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 DeploymentListInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DeploymentListInfo | DeploymentListInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object