Class: GetClusterInfoResponse
workflowservice.v1.GetClusterInfoResponse
GetClusterInfoResponse contains information about Temporal cluster.
Implements
Constructors
constructor
• new GetClusterInfoResponse(properties?): GetClusterInfoResponse
Constructs a new GetClusterInfoResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGetClusterInfoResponse | Properties to set |
Returns
Properties
clusterId
• clusterId: string
GetClusterInfoResponse clusterId.
Implementation of
IGetClusterInfoResponse.clusterId
clusterName
• clusterName: string
GetClusterInfoResponse clusterName.
Implementation of
IGetClusterInfoResponse.clusterName
failoverVersionIncrement
• failoverVersionIncrement: Long
GetClusterInfoResponse failoverVersionIncrement.
Implementation of
IGetClusterInfoResponse.failoverVersionIncrement
historyShardCount
• historyShardCount: number
GetClusterInfoResponse historyShardCount.
Implementation of
IGetClusterInfoResponse.historyShardCount
initialFailoverVersion
• initialFailoverVersion: Long
GetClusterInfoResponse initialFailoverVersion.
Implementation of
IGetClusterInfoResponse.initialFailoverVersion
persistenceStore
• persistenceStore: string
GetClusterInfoResponse persistenceStore.
Implementation of
IGetClusterInfoResponse.persistenceStore
serverVersion
• serverVersion: string
GetClusterInfoResponse serverVersion.
Implementation of
IGetClusterInfoResponse.serverVersion
supportedClients
• supportedClients: Object
Key is client name i.e "temporal-go", "temporal-java", or "temporal-cli". Value is ranges of supported versions of this client i.e ">1.1.1 <=1.4.0 || ^5.0.0".
Index signature
▪ [k: string]: string
Implementation of
IGetClusterInfoResponse.supportedClients
versionInfo
• Optional versionInfo: null | IVersionInfo
GetClusterInfoResponse versionInfo.
Implementation of
IGetClusterInfoResponse.versionInfo
visibilityStore
• visibilityStore: string
GetClusterInfoResponse visibilityStore.
Implementation of
IGetClusterInfoResponse.visibilityStore
Methods
toJSON
▸ toJSON(): Object
Converts this GetClusterInfoResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): GetClusterInfoResponse
Creates a new GetClusterInfoResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGetClusterInfoResponse | Properties to set |
Returns
GetClusterInfoResponse instance
decode
▸ decode(reader, length?): GetClusterInfoResponse
Decodes a GetClusterInfoResponse 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
GetClusterInfoResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): GetClusterInfoResponse
Decodes a GetClusterInfoResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
GetClusterInfoResponse
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 GetClusterInfoResponse message. Does not implicitly temporal.api.workflowservice.v1.GetClusterInfoResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IGetClusterInfoResponse | GetClusterInfoResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified GetClusterInfoResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.GetClusterInfoResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IGetClusterInfoResponse | GetClusterInfoResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): GetClusterInfoResponse
Creates a GetClusterInfoResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
GetClusterInfoResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for GetClusterInfoResponse
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 GetClusterInfoResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | GetClusterInfoResponse | GetClusterInfoResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object