public static final class Cluster.Builder extends GeneratedMessageV3.Builder<Cluster.Builder> implements ClusterOrBuilderA cluster instance.
Protobuf type google.cloud.redis.cluster.v1.Cluster
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Cluster.BuilderImplements
ClusterOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllDiscoveryEndpoints(Iterable<? extends DiscoveryEndpoint> values)
public Cluster.Builder addAllDiscoveryEndpoints(Iterable<? extends DiscoveryEndpoint> values)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 |
values |
Iterable<? extends com.google.cloud.redis.cluster.v1.DiscoveryEndpoint> |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addAllPscConfigs(Iterable<? extends PscConfig> values)
public Cluster.Builder addAllPscConfigs(Iterable<? extends PscConfig> values)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 |
values |
Iterable<? extends com.google.cloud.redis.cluster.v1.PscConfig> |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addAllPscConnections(Iterable<? extends PscConnection> values)
public Cluster.Builder addAllPscConnections(Iterable<? extends PscConnection> values)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 |
values |
Iterable<? extends com.google.cloud.redis.cluster.v1.PscConnection> |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addDiscoveryEndpoints(DiscoveryEndpoint value)
public Cluster.Builder addDiscoveryEndpoints(DiscoveryEndpoint value)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 |
value |
DiscoveryEndpoint |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addDiscoveryEndpoints(DiscoveryEndpoint.Builder builderForValue)
public Cluster.Builder addDiscoveryEndpoints(DiscoveryEndpoint.Builder builderForValue)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 |
builderForValue |
DiscoveryEndpoint.Builder |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addDiscoveryEndpoints(int index, DiscoveryEndpoint value)
public Cluster.Builder addDiscoveryEndpoints(int index, DiscoveryEndpoint value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
DiscoveryEndpoint |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addDiscoveryEndpoints(int index, DiscoveryEndpoint.Builder builderForValue)
public Cluster.Builder addDiscoveryEndpoints(int index, DiscoveryEndpoint.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
DiscoveryEndpoint.Builder |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addDiscoveryEndpointsBuilder()
public DiscoveryEndpoint.Builder addDiscoveryEndpointsBuilder()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 |
DiscoveryEndpoint.Builder |
|
addDiscoveryEndpointsBuilder(int index)
public DiscoveryEndpoint.Builder addDiscoveryEndpointsBuilder(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.Builder |
|
addPscConfigs(PscConfig value)
public Cluster.Builder addPscConfigs(PscConfig value)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 |
value |
PscConfig |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addPscConfigs(PscConfig.Builder builderForValue)
public Cluster.Builder addPscConfigs(PscConfig.Builder builderForValue)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 |
builderForValue |
PscConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addPscConfigs(int index, PscConfig value)
public Cluster.Builder addPscConfigs(int index, PscConfig value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
PscConfig |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addPscConfigs(int index, PscConfig.Builder builderForValue)
public Cluster.Builder addPscConfigs(int index, PscConfig.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
PscConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addPscConfigsBuilder()
public PscConfig.Builder addPscConfigsBuilder()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 |
PscConfig.Builder |
|
addPscConfigsBuilder(int index)
public PscConfig.Builder addPscConfigsBuilder(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.Builder |
|
addPscConnections(PscConnection value)
public Cluster.Builder addPscConnections(PscConnection value)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 |
value |
PscConnection |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addPscConnections(PscConnection.Builder builderForValue)
public Cluster.Builder addPscConnections(PscConnection.Builder builderForValue)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 |
builderForValue |
PscConnection.Builder |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addPscConnections(int index, PscConnection value)
public Cluster.Builder addPscConnections(int index, PscConnection value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
PscConnection |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addPscConnections(int index, PscConnection.Builder builderForValue)
public Cluster.Builder addPscConnections(int index, PscConnection.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
PscConnection.Builder |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
addPscConnectionsBuilder()
public PscConnection.Builder addPscConnectionsBuilder()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 |
PscConnection.Builder |
|
addPscConnectionsBuilder(int index)
public PscConnection.Builder addPscConnectionsBuilder(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.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Cluster.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
build()
public Cluster build()| Returns | |
|---|---|
| Type | Description |
Cluster |
|
buildPartial()
public Cluster buildPartial()| Returns | |
|---|---|
| Type | Description |
Cluster |
|
clear()
public Cluster.Builder clear()| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
clearAuthorizationMode()
public Cluster.Builder clearAuthorizationMode()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 |
Cluster.Builder |
This builder for chaining. |
clearCreateTime()
public Cluster.Builder clearCreateTime()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 |
Cluster.Builder |
|
clearDeletionProtectionEnabled()
public Cluster.Builder clearDeletionProtectionEnabled()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 |
Cluster.Builder |
This builder for chaining. |
clearDiscoveryEndpoints()
public Cluster.Builder clearDiscoveryEndpoints()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 |
Cluster.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Cluster.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
clearName()
public Cluster.Builder clearName() 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 |
Cluster.Builder |
This builder for chaining. |
clearNodeType()
public Cluster.Builder clearNodeType()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 |
Cluster.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Cluster.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
clearPersistenceConfig()
public Cluster.Builder clearPersistenceConfig()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 |
Cluster.Builder |
|
clearPreciseSizeGb()
public Cluster.Builder clearPreciseSizeGb()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 |
Cluster.Builder |
This builder for chaining. |
clearPscConfigs()
public Cluster.Builder clearPscConfigs()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 |
Cluster.Builder |
|
clearPscConnections()
public Cluster.Builder clearPscConnections()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 |
Cluster.Builder |
|
clearRedisConfigs()
public Cluster.Builder clearRedisConfigs()| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
clearReplicaCount()
public Cluster.Builder clearReplicaCount()Optional. The number of replica nodes per shard.
optional int32 replica_count = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
clearShardCount()
public Cluster.Builder clearShardCount()Required. Number of shards for the Redis cluster.
optional int32 shard_count = 14 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
clearSizeGb()
public Cluster.Builder clearSizeGb()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 |
Cluster.Builder |
This builder for chaining. |
clearState()
public Cluster.Builder clearState()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.Builder |
This builder for chaining. |
clearStateInfo()
public Cluster.Builder clearStateInfo()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.Builder |
|
clearTransitEncryptionMode()
public Cluster.Builder clearTransitEncryptionMode()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 |
Cluster.Builder |
This builder for chaining. |
clearUid()
public Cluster.Builder clearUid()Output only. System assigned, unique identifier for the cluster.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
clearZoneDistributionConfig()
public Cluster.Builder clearZoneDistributionConfig()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 |
Cluster.Builder |
|
clone()
public Cluster.Builder clone()| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
containsRedisConfigs(String key)
public 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 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 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 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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()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 |
Builder |
|
getCreateTimeOrBuilder()
public 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 |
|
getDefaultInstanceForType()
public Cluster getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Cluster |
|
getDeletionProtectionEnabled()
public 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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDiscoveryEndpoints(int index)
public 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 |
|
getDiscoveryEndpointsBuilder(int index)
public DiscoveryEndpoint.Builder getDiscoveryEndpointsBuilder(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.Builder |
|
getDiscoveryEndpointsBuilderList()
public List<DiscoveryEndpoint.Builder> getDiscoveryEndpointsBuilderList()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<Builder> |
|
getDiscoveryEndpointsCount()
public 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 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 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 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> |
|
getMutableRedisConfigs() (deprecated)
public Map<String,String> getMutableRedisConfigs()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
public 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 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 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 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 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. |
getPersistenceConfigBuilder()
public ClusterPersistenceConfig.Builder getPersistenceConfigBuilder()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.Builder |
|
getPersistenceConfigOrBuilder()
public 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 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 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 |
|
getPscConfigsBuilder(int index)
public PscConfig.Builder getPscConfigsBuilder(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.Builder |
|
getPscConfigsBuilderList()
public List<PscConfig.Builder> getPscConfigsBuilderList()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<Builder> |
|
getPscConfigsCount()
public 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 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 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 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 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 |
|
getPscConnectionsBuilder(int index)
public PscConnection.Builder getPscConnectionsBuilder(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.Builder |
|
getPscConnectionsBuilderList()
public List<PscConnection.Builder> getPscConnectionsBuilderList()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<Builder> |
|
getPscConnectionsCount()
public 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 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 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 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 Map<String,String> getRedisConfigs()Use #getRedisConfigsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getRedisConfigsCount()
public 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 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 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 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 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 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 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 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 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. |
getStateInfoBuilder()
public Cluster.StateInfo.Builder getStateInfoBuilder()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.Builder |
|
getStateInfoOrBuilder()
public 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 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 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 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 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 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 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. |
getZoneDistributionConfigBuilder()
public ZoneDistributionConfig.Builder getZoneDistributionConfigBuilder()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.Builder |
|
getZoneDistributionConfigOrBuilder()
public 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 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 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 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCreateTime(Timestamp value)
public Cluster.Builder mergeCreateTime(Timestamp value)Output only. The timestamp associated with the cluster creation request.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
mergeFrom(Cluster other)
public Cluster.Builder mergeFrom(Cluster other)| Parameter | |
|---|---|
| Name | Description |
other |
Cluster |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Cluster.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Cluster.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
mergePersistenceConfig(ClusterPersistenceConfig value)
public Cluster.Builder mergePersistenceConfig(ClusterPersistenceConfig value)Optional. Persistence config (RDB, AOF) for the cluster.
.google.cloud.redis.cluster.v1.ClusterPersistenceConfig persistence_config = 20 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ClusterPersistenceConfig |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
mergeStateInfo(Cluster.StateInfo value)
public Cluster.Builder mergeStateInfo(Cluster.StateInfo value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Cluster.StateInfo |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Cluster.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
mergeZoneDistributionConfig(ZoneDistributionConfig value)
public Cluster.Builder mergeZoneDistributionConfig(ZoneDistributionConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ZoneDistributionConfig |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
putAllRedisConfigs(Map<String,String> values)
public Cluster.Builder putAllRedisConfigs(Map<String,String> values)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 |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
putRedisConfigs(String key, String value)
public Cluster.Builder putRedisConfigs(String key, String value)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 |
value |
String |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
removeDiscoveryEndpoints(int index)
public Cluster.Builder removeDiscoveryEndpoints(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 |
Cluster.Builder |
|
removePscConfigs(int index)
public Cluster.Builder removePscConfigs(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 |
Cluster.Builder |
|
removePscConnections(int index)
public Cluster.Builder removePscConnections(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 |
Cluster.Builder |
|
removeRedisConfigs(String key)
public Cluster.Builder removeRedisConfigs(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 |
Cluster.Builder |
|
setAuthorizationMode(AuthorizationMode value)
public Cluster.Builder setAuthorizationMode(AuthorizationMode value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
AuthorizationModeThe authorizationMode to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setAuthorizationModeValue(int value)
public Cluster.Builder setAuthorizationModeValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for authorizationMode to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setCreateTime(Timestamp value)
public Cluster.Builder setCreateTime(Timestamp value)Output only. The timestamp associated with the cluster creation request.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public Cluster.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. The timestamp associated with the cluster creation request.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setDeletionProtectionEnabled(boolean value)
public Cluster.Builder setDeletionProtectionEnabled(boolean value)Optional. The delete operation will fail when the value is set to true.
optional bool deletion_protection_enabled = 25 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe deletionProtectionEnabled to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setDiscoveryEndpoints(int index, DiscoveryEndpoint value)
public Cluster.Builder setDiscoveryEndpoints(int index, DiscoveryEndpoint value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
DiscoveryEndpoint |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setDiscoveryEndpoints(int index, DiscoveryEndpoint.Builder builderForValue)
public Cluster.Builder setDiscoveryEndpoints(int index, DiscoveryEndpoint.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
DiscoveryEndpoint.Builder |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Cluster.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setName(String value)
public Cluster.Builder setName(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Cluster.Builder setNameBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setNodeType(NodeType value)
public Cluster.Builder setNodeType(NodeType value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
NodeTypeThe nodeType to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setNodeTypeValue(int value)
public Cluster.Builder setNodeTypeValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for nodeType to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setPersistenceConfig(ClusterPersistenceConfig value)
public Cluster.Builder setPersistenceConfig(ClusterPersistenceConfig value)Optional. Persistence config (RDB, AOF) for the cluster.
.google.cloud.redis.cluster.v1.ClusterPersistenceConfig persistence_config = 20 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ClusterPersistenceConfig |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setPersistenceConfig(ClusterPersistenceConfig.Builder builderForValue)
public Cluster.Builder setPersistenceConfig(ClusterPersistenceConfig.Builder builderForValue)Optional. Persistence config (RDB, AOF) for the cluster.
.google.cloud.redis.cluster.v1.ClusterPersistenceConfig persistence_config = 20 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ClusterPersistenceConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setPreciseSizeGb(double value)
public Cluster.Builder setPreciseSizeGb(double value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
doubleThe preciseSizeGb to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setPscConfigs(int index, PscConfig value)
public Cluster.Builder setPscConfigs(int index, PscConfig value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
PscConfig |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setPscConfigs(int index, PscConfig.Builder builderForValue)
public Cluster.Builder setPscConfigs(int index, PscConfig.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
PscConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setPscConnections(int index, PscConnection value)
public Cluster.Builder setPscConnections(int index, PscConnection value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
PscConnection |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setPscConnections(int index, PscConnection.Builder builderForValue)
public Cluster.Builder setPscConnections(int index, PscConnection.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
PscConnection.Builder |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Cluster.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setReplicaCount(int value)
public Cluster.Builder setReplicaCount(int value)Optional. The number of replica nodes per shard.
optional int32 replica_count = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe replicaCount to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setShardCount(int value)
public Cluster.Builder setShardCount(int value)Required. Number of shards for the Redis cluster.
optional int32 shard_count = 14 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe shardCount to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setSizeGb(int value)
public Cluster.Builder setSizeGb(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe sizeGb to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setState(Cluster.State value)
public Cluster.Builder setState(Cluster.State value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Cluster.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setStateInfo(Cluster.StateInfo value)
public Cluster.Builder setStateInfo(Cluster.StateInfo value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Cluster.StateInfo |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setStateInfo(Cluster.StateInfo.Builder builderForValue)
public Cluster.Builder setStateInfo(Cluster.StateInfo.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Cluster.StateInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setStateValue(int value)
public Cluster.Builder setStateValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setTransitEncryptionMode(TransitEncryptionMode value)
public Cluster.Builder setTransitEncryptionMode(TransitEncryptionMode value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
TransitEncryptionModeThe transitEncryptionMode to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setTransitEncryptionModeValue(int value)
public Cluster.Builder setTransitEncryptionModeValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for transitEncryptionMode to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setUid(String value)
public Cluster.Builder setUid(String value)Output only. System assigned, unique identifier for the cluster.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe uid to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setUidBytes(ByteString value)
public Cluster.Builder setUidBytes(ByteString value)Output only. System assigned, unique identifier for the cluster.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for uid to set. |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Cluster.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setZoneDistributionConfig(ZoneDistributionConfig value)
public Cluster.Builder setZoneDistributionConfig(ZoneDistributionConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ZoneDistributionConfig |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
setZoneDistributionConfig(ZoneDistributionConfig.Builder builderForValue)
public Cluster.Builder setZoneDistributionConfig(ZoneDistributionConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ZoneDistributionConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|