Package com.oracle.bmc.redis.model

Class CreateRedisClusterDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.redis.model.CreateRedisClusterDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220315")
public final class CreateRedisClusterDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The configuration details for a new OCI Cache cluster.

An OCI Cache cluster is a memory-based storage solution. For more information, see OCI Cache.
Note: Objects should always be created or deserialized using the CreateRedisClusterDetails.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 CreateRedisClusterDetails.Builder, which maintain a set of all explicitly set fields called CreateRedisClusterDetails.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateRedisClusterDetails.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

CreateRedisClusterDetails(String ociCacheConfigSetId, RedisCluster.ClusterMode clusterMode, Integer shardCount, String displayName, String compartmentId, Integer nodeCount, RedisCluster.SoftwareVersion softwareVersion, Float nodeMemoryInGBs, String subnetId, List<String> nsgIds, Map<String,Map<String,Object>> securityAttributes, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateRedisClusterDetails.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.
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	getOciCacheConfigSetId()	The ID of the corresponding OCI Cache Config Set for the cluster.
Map<String,Map<String,Object>>	getSecurityAttributes()	Security attributes for redis cluster resource.
Integer	getShardCount()	The number of shards in sharded cluster.
RedisCluster.SoftwareVersion	getSoftwareVersion()	The OCI Cache engine version that the cluster is running.
String	getSubnetId()	The OCID of the cluster’s subnet.
int	hashCode()
CreateRedisClusterDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateRedisClusterDetails

@Deprecated
@ConstructorProperties({"ociCacheConfigSetId","clusterMode","shardCount","displayName","compartmentId","nodeCount","softwareVersion","nodeMemoryInGBs","subnetId","nsgIds","securityAttributes","freeformTags","definedTags"})
public CreateRedisClusterDetails(String ociCacheConfigSetId,
                                 RedisCluster.ClusterMode clusterMode,
                                 Integer shardCount,
                                 String displayName,
                                 String compartmentId,
                                 Integer nodeCount,
                                 RedisCluster.SoftwareVersion softwareVersion,
                                 Float nodeMemoryInGBs,
                                 String subnetId,
                                 List<String> nsgIds,
                                 Map<String,Map<String,Object>> securityAttributes,
                                 Map<String,String> freeformTags,
                                 Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static CreateRedisClusterDetails.Builder builder()

Create a new builder.

toBuilder

public CreateRedisClusterDetails.Builder toBuilder()

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 sharded cluster.

Only applicable when clusterMode is SHARDED.

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

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

getSoftwareVersion

public RedisCluster.SoftwareVersion getSoftwareVersion()

The OCI Cache engine version that the cluster is running.

Returns:

the value

getNodeMemoryInGBs

public Float getNodeMemoryInGBs()

The amount of memory allocated to the cluster’s nodes, in gigabytes.

Returns:

the value

getSubnetId

public String getSubnetId()

The OCID of the cluster’s subnet.

Returns:

the value

getNsgIds

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.

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

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