RedisCluster.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.redis.model.RedisCluster.Builder

Enclosing class:: RedisCluster

public static class RedisCluster.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RedisCluster`	`build()`
`RedisCluster.Builder`	`clusterMode(RedisCluster.ClusterMode clusterMode)` Specifies whether the cluster is sharded or non-sharded.
`RedisCluster.Builder`	`compartmentId(String compartmentId)` The OCID of the compartment that contains the cluster.
`RedisCluster.Builder`	`copy(RedisCluster model)`
`RedisCluster.Builder`	`definedTags(Map<String,Map<String,Object>> definedTags)` Defined tags for this resource.
`RedisCluster.Builder`	`displayName(String displayName)` A user-friendly name.
`RedisCluster.Builder`	`freeformTags(Map<String,String> freeformTags)` Simple key-value pair that is applied without any predefined name, type or scope.
`RedisCluster.Builder`	`id(String id)` The OCID of the cluster.
`RedisCluster.Builder`	`lifecycleDetails(String lifecycleDetails)` A message describing the current state in more detail.
`RedisCluster.Builder`	`lifecycleState(RedisCluster.LifecycleState lifecycleState)` The current state of the cluster.
`RedisCluster.Builder`	`nodeCollection(NodeCollection nodeCollection)`
`RedisCluster.Builder`	`nodeCount(Integer nodeCount)` The number of nodes per shard in the cluster when clusterMode is SHARDED.
`RedisCluster.Builder`	`nodeMemoryInGBs(Float nodeMemoryInGBs)` The amount of memory allocated to the cluster’s nodes, in gigabytes.
`RedisCluster.Builder`	`nsgIds(List<String> nsgIds)` A list of Network Security Group (NSG) OCIDs associated with this cluster.
`RedisCluster.Builder`	`primaryEndpointIpAddress(String primaryEndpointIpAddress)` The private IP address of the API endpoint for the cluster’s primary node.
`RedisCluster.Builder`	`primaryFqdn(String primaryFqdn)` The fully qualified domain name (FQDN) of the API endpoint for the cluster’s primary node.
`RedisCluster.Builder`	`replicasEndpointIpAddress(String replicasEndpointIpAddress)` The private IP address of the API endpoint for the cluster’s replica nodes.
`RedisCluster.Builder`	`replicasFqdn(String replicasFqdn)` The fully qualified domain name (FQDN) of the API endpoint for the cluster’s replica nodes.
`RedisCluster.Builder`	`shardCount(Integer shardCount)` The number of shards in a sharded cluster.
`RedisCluster.Builder`	`softwareVersion(RedisCluster.SoftwareVersion softwareVersion)` The OCI Cache engine version that the cluster is running.
`RedisCluster.Builder`	`subnetId(String subnetId)` The OCID of the cluster’s subnet.
`RedisCluster.Builder`	`systemTags(Map<String,Map<String,Object>> systemTags)` Usage of system tag keys.
`RedisCluster.Builder`	`timeCreated(Date timeCreated)` The date and time the cluster was created.
`RedisCluster.Builder`	`timeUpdated(Date timeUpdated)` The date and time the cluster was updated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - id
```
public RedisCluster.Builder id(String id)
```
    The OCID of the cluster.
    
    Parameters:
    
    id - the value to set
    
    Returns:
    
    this builder
  - displayName
```
public RedisCluster.Builder displayName(String displayName)
```
    A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
    
    Parameters:
    
    displayName - the value to set
    
    Returns:
    
    this builder
  - compartmentId
```
public RedisCluster.Builder compartmentId(String compartmentId)
```
    The OCID of the compartment that contains the cluster.
    
    Parameters:
    
    compartmentId - the value to set
    
    Returns:
    
    this builder
  - lifecycleState
```
public RedisCluster.Builder lifecycleState(RedisCluster.LifecycleState lifecycleState)
```
    The current state of the cluster.
    
    Parameters:
    
    lifecycleState - the value to set
    
    Returns:
    
    this builder
  - lifecycleDetails
```
public RedisCluster.Builder lifecycleDetails(String lifecycleDetails)
```
    A message describing the current state in more detail. For example, the message might provide actionable information for a resource in FAILED state.
    
    Parameters:
    
    lifecycleDetails - the value to set
    
    Returns:
    
    this builder
  - nodeCount
```
public RedisCluster.Builder nodeCount(Integer nodeCount)
```
    The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.
    
    Parameters:
    
    nodeCount - the value to set
    
    Returns:
    
    this builder
  - nodeMemoryInGBs
```
public RedisCluster.Builder nodeMemoryInGBs(Float nodeMemoryInGBs)
```
    The amount of memory allocated to the cluster’s nodes, in gigabytes.
    
    Parameters:
    
    nodeMemoryInGBs - the value to set
    
    Returns:
    
    this builder
  - primaryFqdn
```
public RedisCluster.Builder primaryFqdn(String primaryFqdn)
```
    The fully qualified domain name (FQDN) of the API endpoint for the cluster’s primary node.
    
    Parameters:
    
    primaryFqdn - the value to set
    
    Returns:
    
    this builder
  - primaryEndpointIpAddress
```
public RedisCluster.Builder primaryEndpointIpAddress(String primaryEndpointIpAddress)
```
    The private IP address of the API endpoint for the cluster’s primary node.
    
    Parameters:
    
    primaryEndpointIpAddress - the value to set
    
    Returns:
    
    this builder
  - replicasFqdn
```
public RedisCluster.Builder replicasFqdn(String replicasFqdn)
```
    The fully qualified domain name (FQDN) of the API endpoint for the cluster’s replica nodes.
    
    Parameters:
    
    replicasFqdn - the value to set
    
    Returns:
    
    this builder
  - replicasEndpointIpAddress
```
public RedisCluster.Builder replicasEndpointIpAddress(String replicasEndpointIpAddress)
```
    The private IP address of the API endpoint for the cluster’s replica nodes.
    
    Parameters:
    
    replicasEndpointIpAddress - the value to set
    
    Returns:
    
    this builder
  - softwareVersion
```
public RedisCluster.Builder softwareVersion(RedisCluster.SoftwareVersion softwareVersion)
```
    The OCI Cache engine version that the cluster is running.
    
    Parameters:
    
    softwareVersion - the value to set
    
    Returns:
    
    this builder
  - subnetId
```
public RedisCluster.Builder subnetId(String subnetId)
```
    The OCID of the cluster’s subnet.
    
    Parameters:
    
    subnetId - the value to set
    
    Returns:
    
    this builder
  - timeCreated
```
public RedisCluster.Builder timeCreated(Date timeCreated)
```
    The date and time the cluster was created. An RFC3339 formatted datetime string.
    
    Parameters:
    
    timeCreated - the value to set
    
    Returns:
    
    this builder
  - timeUpdated
```
public RedisCluster.Builder timeUpdated(Date timeUpdated)
```
    The date and time the cluster was updated. An RFC3339 formatted datetime string.
    
    Parameters:
    
    timeUpdated - the value to set
    
    Returns:
    
    this builder
  - nodeCollection
```
public RedisCluster.Builder nodeCollection(NodeCollection nodeCollection)
```
  - clusterMode
```
public RedisCluster.Builder clusterMode(RedisCluster.ClusterMode clusterMode)
```
    Specifies whether the cluster is sharded or non-sharded.
    
    Parameters:
    
    clusterMode - the value to set
    
    Returns:
    
    this builder
  - shardCount
```
public RedisCluster.Builder shardCount(Integer shardCount)
```
    The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
    
    Parameters:
    
    shardCount - the value to set
    
    Returns:
    
    this builder
  - nsgIds
```
public RedisCluster.Builder nsgIds(List<String> nsgIds)
```
    A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.
    
    Parameters:
    
    nsgIds - the value to set
    
    Returns:
    
    this builder
  - freeformTags
```
public RedisCluster.Builder freeformTags(Map<String,String> freeformTags)
```
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    
    Parameters:
    
    freeformTags - the value to set
    
    Returns:
    
    this builder
  - definedTags
```
public RedisCluster.Builder definedTags(Map<String,Map<String,Object>> definedTags)
```
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
    
    Parameters:
    
    definedTags - the value to set
    
    Returns:
    
    this builder
  - systemTags
```
public RedisCluster.Builder systemTags(Map<String,Map<String,Object>> systemTags)
```
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
    
    Parameters:
    
    systemTags - the value to set
    
    Returns:
    
    this builder
  - build
```
public RedisCluster build()
```
  - copy
```
public RedisCluster.Builder copy(RedisCluster model)
```

Class RedisCluster.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

id

displayName

compartmentId

lifecycleState

lifecycleDetails

nodeCount

nodeMemoryInGBs

primaryFqdn

primaryEndpointIpAddress

replicasFqdn

replicasEndpointIpAddress

softwareVersion

subnetId

timeCreated

timeUpdated

nodeCollection

clusterMode

shardCount

nsgIds

freeformTags

definedTags

systemTags

build

copy