Class: GetClusterInfoResponse
GetClusterInfoResponse contains information about Temporal cluster.
Properties
clusterId
clusterId:
string
GetClusterInfoResponse clusterId.
clusterName
clusterName:
string
GetClusterInfoResponse clusterName.
failoverVersionIncrement
failoverVersionIncrement:
Long
GetClusterInfoResponse failoverVersionIncrement.
historyShardCount
historyShardCount:
number
GetClusterInfoResponse historyShardCount.
initialFailoverVersion
initialFailoverVersion:
Long
GetClusterInfoResponse initialFailoverVersion.
persistenceStore
persistenceStore:
string
GetClusterInfoResponse persistenceStore.
serverVersion
serverVersion:
string
GetClusterInfoResponse 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
versionInfo?
optionalversionInfo?:$Properties|null
GetClusterInfoResponse versionInfo.
visibilityStore
visibilityStore:
string
GetClusterInfoResponse visibilityStore.
Methods
toJSON()
toJSON():
object
Converts this GetClusterInfoResponse to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):GetClusterInfoResponse&$Properties
Creates a new GetClusterInfoResponse instance using the specified properties.
Parameters
properties?
Properties to set
Returns
GetClusterInfoResponse & $Properties
GetClusterInfoResponse instance
Call Signature
staticcreate(properties?):GetClusterInfoResponse
Creates a new GetClusterInfoResponse instance using the specified properties.
Parameters
properties?
Properties to set
Returns
GetClusterInfoResponse
GetClusterInfoResponse instance
decode()
staticdecode(reader,length?):GetClusterInfoResponse&$Properties
Decodes a GetClusterInfoResponse message from the specified reader or buffer.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
length?
number
Message length if known beforehand
Returns
GetClusterInfoResponse & $Properties
GetClusterInfoResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):GetClusterInfoResponse&$Properties
Decodes a GetClusterInfoResponse message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
GetClusterInfoResponse & $Properties
GetClusterInfoResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified GetClusterInfoResponse message. Does not implicitly temporal.api.workflowservice.v1.GetClusterInfoResponse.verify|verify messages.
Parameters
message
GetClusterInfoResponse message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified GetClusterInfoResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.GetClusterInfoResponse.verify|verify messages.
Parameters
message
GetClusterInfoResponse message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):GetClusterInfoResponse
Creates a GetClusterInfoResponse message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
GetClusterInfoResponse
GetClusterInfoResponse
toObject()
statictoObject(message,options?):object
Creates a plain object from a GetClusterInfoResponse message. Also converts values to other types if specified.
Parameters
message
GetClusterInfoResponse
GetClusterInfoResponse
options?
IConversionOptions
Conversion options
Returns
object
Plain object