Package com.oracle.bmc.redis.model

Class RedisClusterSummary

  • @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).

    • Method Detail

      • getId

        public String getId()
        The OCID of the cluster.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the cluster.
        Returns:
        the value

      • getLifecycleDetails

        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.

        Returns:
        the value

      • getNodeCount

        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.

        Returns:
        the value

      • getNodeMemoryInGBs

        public Float getNodeMemoryInGBs()
        The amount of memory allocated to the cluster’s nodes, in gigabytes.
        Returns:
        the value

      • getPrimaryFqdn

        public String getPrimaryFqdn()
        The fully qualified domain name (FQDN) of the API endpoint for the cluster’s primary node.
        Returns:
        the value

      • getPrimaryEndpointIpAddress

        public String getPrimaryEndpointIpAddress()
        The private IP address of the API endpoint for the cluster’s primary node.
        Returns:
        the value

      • getReplicasFqdn

        public String getReplicasFqdn()
        The fully qualified domain name (FQDN) of the API endpoint for the cluster’s replica nodes.
        Returns:
        the value

      • getReplicasEndpointIpAddress

        public String getReplicasEndpointIpAddress()
        The private IP address of the API endpoint for the cluster’s replica nodes.
        Returns:
        the value

      • getDiscoveryFqdn

        public String getDiscoveryFqdn()
        The fully qualified domain name (FQDN) of the API endpoint for sharded cluster discovery.
        Returns:
        the value

      • getDiscoveryEndpointIpAddress

        public String getDiscoveryEndpointIpAddress()
        The private IP address of the API endpoint for shareded cluster discovery.
        Returns:
        the value

      • getSoftwareVersion

        public RedisCluster.SoftwareVersion getSoftwareVersion()
        The OCI Cache engine version that the cluster is running.
        Returns:
        the value

      • getSubnetId

        public String getSubnetId()
        The OCID of the cluster’s subnet.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the cluster was created.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the cluster was updated.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getOciCacheConfigSetId

        public String getOciCacheConfigSetId()
        The ID of the corresponding OCI Cache Config Set for the cluster.
        Returns:
        the value

      • getClusterMode

        public RedisCluster.ClusterMode getClusterMode()
        Specifies whether the cluster is sharded or non-sharded.
        Returns:
        the value

      • getShardCount

        public Integer getShardCount()
        The number of shards in a sharded cluster.

        Only applicable when clusterMode is SHARDED.

        Returns:
        the value

      • getSecurityAttributes

        public Map<String,​Map<String,​Object>> getSecurityAttributes()
        Security attributes for redis cluster resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}

        Returns:
        the value

      • getFreeformTags

        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”}

        Returns:
        the value

      • getDefinedTags

        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”}}

        Returns:
        the value

      • getSystemTags

        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”}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel