Class: ClusterMetadata
operatorservice.v1.ClusterMetadata
Represents a ClusterMetadata.
Implements
Constructors
constructor
• new ClusterMetadata(properties?): ClusterMetadata
Constructs a new ClusterMetadata.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IClusterMetadata | Properties to set |
Returns
Properties
address
• address: string
gRPC address.
Implementation of
clusterId
• clusterId: string
Id of the cluster.
Implementation of
clusterName
• clusterName: string
Name of the cluster name.
Implementation of
historyShardCount
• historyShardCount: number
History service shard number.
Implementation of
IClusterMetadata.historyShardCount
httpAddress
• httpAddress: string
HTTP address, if one exists.
Implementation of
initialFailoverVersion
• initialFailoverVersion: Long
A unique failover version across all connected clusters.
Implementation of
IClusterMetadata.initialFailoverVersion
isConnectionEnabled
• isConnectionEnabled: boolean
A flag to indicate if a connection is active.
Implementation of
IClusterMetadata.isConnectionEnabled
isReplicationEnabled
• isReplicationEnabled: boolean
A flag to indicate if replication is enabled.
Implementation of
IClusterMetadata.isReplicationEnabled
Methods
toJSON
▸ toJSON(): Object
Converts this ClusterMetadata to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ClusterMetadata
Creates a new ClusterMetadata instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IClusterMetadata | Properties to set |
Returns
ClusterMetadata instance
decode
▸ decode(reader, length?): ClusterMetadata
Decodes a ClusterMetadata 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
ClusterMetadata
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ClusterMetadata
Decodes a ClusterMetadata message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ClusterMetadata
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 ClusterMetadata message. Does not implicitly temporal.api.operatorservice.v1.ClusterMetadata.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IClusterMetadata | ClusterMetadata message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ClusterMetadata message, length delimited. Does not implicitly temporal.api.operatorservice.v1.ClusterMetadata.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IClusterMetadata | ClusterMetadata message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ClusterMetadata
Creates a ClusterMetadata message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ClusterMetadata
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ClusterMetadata
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 ClusterMetadata message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ClusterMetadata | ClusterMetadata |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object