Interface ClusterOrBuilder (0.27.0) 

public interface ClusterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsRedisConfigs(String key)

public abstract boolean containsRedisConfigs(String key)

Optional. Key/Value pairs of customer overrides for mutable Redis Configs

map<string, string> redis_configs = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getAuthorizationMode()

public abstract AuthorizationMode getAuthorizationMode()

Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.

.google.cloud.redis.cluster.v1.AuthorizationMode authorization_mode = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AuthorizationMode

The authorizationMode.

getAuthorizationModeValue()

public abstract int getAuthorizationModeValue()

Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.

.google.cloud.redis.cluster.v1.AuthorizationMode authorization_mode = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for authorizationMode.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The timestamp associated with the cluster creation request.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp associated with the cluster creation request.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDeletionProtectionEnabled()

public abstract boolean getDeletionProtectionEnabled()

Optional. The delete operation will fail when the value is set to true.

optional bool deletion_protection_enabled = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The deletionProtectionEnabled.

getDiscoveryEndpoints(int index)

public abstract DiscoveryEndpoint getDiscoveryEndpoints(int index)

Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

repeated .google.cloud.redis.cluster.v1.DiscoveryEndpoint discovery_endpoints = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DiscoveryEndpoint

getDiscoveryEndpointsCount()

public abstract int getDiscoveryEndpointsCount()

Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

repeated .google.cloud.redis.cluster.v1.DiscoveryEndpoint discovery_endpoints = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getDiscoveryEndpointsList()

public abstract List<DiscoveryEndpoint> getDiscoveryEndpointsList()

Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

repeated .google.cloud.redis.cluster.v1.DiscoveryEndpoint discovery_endpoints = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<DiscoveryEndpoint>

getDiscoveryEndpointsOrBuilder(int index)

public abstract DiscoveryEndpointOrBuilder getDiscoveryEndpointsOrBuilder(int index)

Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

repeated .google.cloud.redis.cluster.v1.DiscoveryEndpoint discovery_endpoints = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DiscoveryEndpointOrBuilder

getDiscoveryEndpointsOrBuilderList()

public abstract List<? extends DiscoveryEndpointOrBuilder> getDiscoveryEndpointsOrBuilderList()

Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.

repeated .google.cloud.redis.cluster.v1.DiscoveryEndpoint discovery_endpoints = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.redis.cluster.v1.DiscoveryEndpointOrBuilder>

getName()

public abstract String getName()

Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getNodeType()

public abstract NodeType getNodeType()

Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.

.google.cloud.redis.cluster.v1.NodeType node_type = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NodeType

The nodeType.

getNodeTypeValue()

public abstract int getNodeTypeValue()

Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.

.google.cloud.redis.cluster.v1.NodeType node_type = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for nodeType.

getPersistenceConfig()

public abstract ClusterPersistenceConfig getPersistenceConfig()

Optional. Persistence config (RDB, AOF) for the cluster.

.google.cloud.redis.cluster.v1.ClusterPersistenceConfig persistence_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClusterPersistenceConfig

The persistenceConfig.

getPersistenceConfigOrBuilder()

public abstract ClusterPersistenceConfigOrBuilder getPersistenceConfigOrBuilder()

Optional. Persistence config (RDB, AOF) for the cluster.

.google.cloud.redis.cluster.v1.ClusterPersistenceConfig persistence_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClusterPersistenceConfigOrBuilder

getPreciseSizeGb()

public abstract double getPreciseSizeGb()

Output only. Precise value of redis memory size in GB for the entire cluster.

optional double precise_size_gb = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
double

The preciseSizeGb.

getPscConfigs(int index)

public abstract PscConfig getPscConfigs(int index)

Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.

repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
PscConfig

getPscConfigsCount()

public abstract int getPscConfigsCount()

Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.

repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getPscConfigsList()

public abstract List<PscConfig> getPscConfigsList()

Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.

repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<PscConfig>

getPscConfigsOrBuilder(int index)

public abstract PscConfigOrBuilder getPscConfigsOrBuilder(int index)

Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.

repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
PscConfigOrBuilder

getPscConfigsOrBuilderList()

public abstract List<? extends PscConfigOrBuilder> getPscConfigsOrBuilderList()

Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.

repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.redis.cluster.v1.PscConfigOrBuilder>

getPscConnections(int index)

public abstract PscConnection getPscConnections(int index)

Output only. PSC connections for discovery of the cluster topology and accessing the cluster.

repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PscConnection

getPscConnectionsCount()

public abstract int getPscConnectionsCount()

Output only. PSC connections for discovery of the cluster topology and accessing the cluster.

repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getPscConnectionsList()

public abstract List<PscConnection> getPscConnectionsList()

Output only. PSC connections for discovery of the cluster topology and accessing the cluster.

repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<PscConnection>

getPscConnectionsOrBuilder(int index)

public abstract PscConnectionOrBuilder getPscConnectionsOrBuilder(int index)

Output only. PSC connections for discovery of the cluster topology and accessing the cluster.

repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PscConnectionOrBuilder

getPscConnectionsOrBuilderList()

public abstract List<? extends PscConnectionOrBuilder> getPscConnectionsOrBuilderList()

Output only. PSC connections for discovery of the cluster topology and accessing the cluster.

repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.redis.cluster.v1.PscConnectionOrBuilder>

getRedisConfigs() (deprecated)

public abstract Map<String,String> getRedisConfigs()

Use #getRedisConfigsMap() instead.

Returns
Type Description
Map<String,String>

getRedisConfigsCount()

public abstract int getRedisConfigsCount()

Optional. Key/Value pairs of customer overrides for mutable Redis Configs

map<string, string> redis_configs = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getRedisConfigsMap()

public abstract Map<String,String> getRedisConfigsMap()

Optional. Key/Value pairs of customer overrides for mutable Redis Configs

map<string, string> redis_configs = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getRedisConfigsOrDefault(String key, String defaultValue)

public abstract String getRedisConfigsOrDefault(String key, String defaultValue)

Optional. Key/Value pairs of customer overrides for mutable Redis Configs

map<string, string> redis_configs = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getRedisConfigsOrThrow(String key)

public abstract String getRedisConfigsOrThrow(String key)

Optional. Key/Value pairs of customer overrides for mutable Redis Configs

map<string, string> redis_configs = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getReplicaCount()

public abstract int getReplicaCount()

Optional. The number of replica nodes per shard.

optional int32 replica_count = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The replicaCount.

getShardCount()

public abstract int getShardCount()

Required. Number of shards for the Redis cluster.

optional int32 shard_count = 14 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The shardCount.

getSizeGb()

public abstract int getSizeGb()

Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.

optional int32 size_gb = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The sizeGb.

getState()

public abstract Cluster.State getState()

Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED

.google.cloud.redis.cluster.v1.Cluster.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.State

The state.

getStateInfo()

public abstract Cluster.StateInfo getStateInfo()

Output only. Additional information about the current state of the cluster.

.google.cloud.redis.cluster.v1.Cluster.StateInfo state_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.StateInfo

The stateInfo.

getStateInfoOrBuilder()

public abstract Cluster.StateInfoOrBuilder getStateInfoOrBuilder()

Output only. Additional information about the current state of the cluster.

.google.cloud.redis.cluster.v1.Cluster.StateInfo state_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.StateInfoOrBuilder

getStateValue()

public abstract int getStateValue()

Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED

.google.cloud.redis.cluster.v1.Cluster.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTransitEncryptionMode()

public abstract TransitEncryptionMode getTransitEncryptionMode()

Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.

.google.cloud.redis.cluster.v1.TransitEncryptionMode transit_encryption_mode = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransitEncryptionMode

The transitEncryptionMode.

getTransitEncryptionModeValue()

public abstract int getTransitEncryptionModeValue()

Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.

.google.cloud.redis.cluster.v1.TransitEncryptionMode transit_encryption_mode = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for transitEncryptionMode.

getUid()

public abstract String getUid()

Output only. System assigned, unique identifier for the cluster.

string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. System assigned, unique identifier for the cluster.

string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

getZoneDistributionConfig()

public abstract ZoneDistributionConfig getZoneDistributionConfig()

Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.

.google.cloud.redis.cluster.v1.ZoneDistributionConfig zone_distribution_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ZoneDistributionConfig

The zoneDistributionConfig.

getZoneDistributionConfigOrBuilder()

public abstract ZoneDistributionConfigOrBuilder getZoneDistributionConfigOrBuilder()

Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.

.google.cloud.redis.cluster.v1.ZoneDistributionConfig zone_distribution_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ZoneDistributionConfigOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The timestamp associated with the cluster creation request.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeletionProtectionEnabled()

public abstract boolean hasDeletionProtectionEnabled()

Optional. The delete operation will fail when the value is set to true.

optional bool deletion_protection_enabled = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the deletionProtectionEnabled field is set.

hasPersistenceConfig()

public abstract boolean hasPersistenceConfig()

Optional. Persistence config (RDB, AOF) for the cluster.

.google.cloud.redis.cluster.v1.ClusterPersistenceConfig persistence_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the persistenceConfig field is set.

hasPreciseSizeGb()

public abstract boolean hasPreciseSizeGb()

Output only. Precise value of redis memory size in GB for the entire cluster.

optional double precise_size_gb = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the preciseSizeGb field is set.

hasReplicaCount()

public abstract boolean hasReplicaCount()

Optional. The number of replica nodes per shard.

optional int32 replica_count = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the replicaCount field is set.

hasShardCount()

public abstract boolean hasShardCount()

Required. Number of shards for the Redis cluster.

optional int32 shard_count = 14 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the shardCount field is set.

hasSizeGb()

public abstract boolean hasSizeGb()

Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.

optional int32 size_gb = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the sizeGb field is set.

hasStateInfo()

public abstract boolean hasStateInfo()

Output only. Additional information about the current state of the cluster.

.google.cloud.redis.cluster.v1.Cluster.StateInfo state_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the stateInfo field is set.

hasZoneDistributionConfig()

public abstract boolean hasZoneDistributionConfig()

Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.

.google.cloud.redis.cluster.v1.ZoneDistributionConfig zone_distribution_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the zoneDistributionConfig field is set.