@Generated(value="OracleSDKGenerator",
comments="API Version: 20220315")
public final class RedisClusterSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Summary of information about a cluster. A cluster is a memory-based storage solution. For more
information, see OCI Cache.
Note: Objects should always be created or deserialized using the RedisClusterSummary.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the RedisClusterSummary.Builder, which maintain a
set of all explicitly set fields called RedisClusterSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
RedisClusterSummary.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
RedisClusterSummary(String id,
String displayName,
String compartmentId,
RedisCluster.LifecycleState lifecycleState,
String lifecycleDetails,
Integer nodeCount,
Float nodeMemoryInGBs,
String primaryFqdn,
String primaryEndpointIpAddress,
String replicasFqdn,
String replicasEndpointIpAddress,
RedisCluster.SoftwareVersion softwareVersion,
String subnetId,
Date timeCreated,
Date timeUpdated,
RedisCluster.ClusterMode clusterMode,
Integer shardCount,
List<String> nsgIds,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static RedisClusterSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
RedisCluster.ClusterMode |
getClusterMode()
Specifies whether the cluster is sharded or non-sharded.
|
String |
getCompartmentId()
The
OCID of
the compartment that contains the cluster.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
String |
getId()
The
OCID of
the cluster.
|
String |
getLifecycleDetails()
A message describing the current state in more detail.
|
RedisCluster.LifecycleState |
getLifecycleState()
The current state of the cluster.
|
Integer |
getNodeCount()
The number of nodes per shard in the cluster when clusterMode is SHARDED.
|
Float |
getNodeMemoryInGBs()
The amount of memory allocated to the cluster’s nodes, in gigabytes.
|
List<String> |
getNsgIds()
A list of Network Security Group (NSG)
OCIDs
associated with this cluster.
|
String |
getPrimaryEndpointIpAddress()
The private IP address of the API endpoint for the cluster’s primary node.
|
String |
getPrimaryFqdn()
The fully qualified domain name (FQDN) of the API endpoint for the cluster’s primary node.
|
String |
getReplicasEndpointIpAddress()
The private IP address of the API endpoint for the cluster’s replica nodes.
|
String |
getReplicasFqdn()
The fully qualified domain name (FQDN) of the API endpoint for the cluster’s replica nodes.
|
Integer |
getShardCount()
The number of shards in a sharded cluster.
|
RedisCluster.SoftwareVersion |
getSoftwareVersion()
The OCI Cache engine version that the cluster is running.
|
String |
getSubnetId()
The
OCID of
the cluster’s subnet.
|
Map<String,Map<String,Object>> |
getSystemTags()
Usage of system tag keys.
|
Date |
getTimeCreated()
The date and time the cluster was created.
|
Date |
getTimeUpdated()
The date and time the cluster was updated.
|
int |
hashCode() |
RedisClusterSummary.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","compartmentId","lifecycleState","lifecycleDetails","nodeCount","nodeMemoryInGBs","primaryFqdn","primaryEndpointIpAddress","replicasFqdn","replicasEndpointIpAddress","softwareVersion","subnetId","timeCreated","timeUpdated","clusterMode","shardCount","nsgIds","freeformTags","definedTags","systemTags"}) public RedisClusterSummary(String id, String displayName, String compartmentId, RedisCluster.LifecycleState lifecycleState, String lifecycleDetails, Integer nodeCount, Float nodeMemoryInGBs, String primaryFqdn, String primaryEndpointIpAddress, String replicasFqdn, String replicasEndpointIpAddress, RedisCluster.SoftwareVersion softwareVersion, String subnetId, Date timeCreated, Date timeUpdated, RedisCluster.ClusterMode clusterMode, Integer shardCount, List<String> nsgIds, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static RedisClusterSummary.Builder builder()
Create a new builder.
public RedisClusterSummary.Builder toBuilder()
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public String getCompartmentId()
The OCID of the compartment that contains the cluster.
public RedisCluster.LifecycleState getLifecycleState()
The current state of the cluster.
public String getLifecycleDetails()
A message describing the current state in more detail. For example, the message might provide
actionable information for a resource in FAILED state.
public Integer getNodeCount()
The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.
public Float getNodeMemoryInGBs()
The amount of memory allocated to the cluster’s nodes, in gigabytes.
public String getPrimaryFqdn()
The fully qualified domain name (FQDN) of the API endpoint for the cluster’s primary node.
public String getPrimaryEndpointIpAddress()
The private IP address of the API endpoint for the cluster’s primary node.
public String getReplicasFqdn()
The fully qualified domain name (FQDN) of the API endpoint for the cluster’s replica nodes.
public String getReplicasEndpointIpAddress()
The private IP address of the API endpoint for the cluster’s replica nodes.
public RedisCluster.SoftwareVersion getSoftwareVersion()
The OCI Cache engine version that the cluster is running.
public Date getTimeCreated()
The date and time the cluster was created. An RFC3339 formatted datetime string.
public Date getTimeUpdated()
The date and time the cluster was updated. An RFC3339 formatted datetime string.
public RedisCluster.ClusterMode getClusterMode()
Specifies whether the cluster is sharded or non-sharded.
public Integer getShardCount()
The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
public List<String> getNsgIds()
A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope. Exists for
cross-compatibility only. Example: {"bar-key": "value"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}}
public Map<String,Map<String,Object>> getSystemTags()
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.