public static final class Cluster.Builder extends GeneratedMessageV3.Builder<Cluster.Builder> implements ClusterOrBuilder
A 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
addAllClusterEndpoints(Iterable<? extends ClusterEndpoint> values)
public Cluster.Builder addAllClusterEndpoints(Iterable<? extends ClusterEndpoint> values)
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.cloud.redis.cluster.v1.ClusterEndpoint> |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
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)
Optional. 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) = OPTIONAL];
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. The list of PSC connections that are auto-created through service connectivity automation.
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 |
addAllPscServiceAttachments(Iterable<? extends PscServiceAttachment> values)
public Cluster.Builder addAllPscServiceAttachments(Iterable<? extends PscServiceAttachment> values)
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.cloud.redis.cluster.v1.PscServiceAttachment> |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
addClusterEndpoints(ClusterEndpoint value)
public Cluster.Builder addClusterEndpoints(ClusterEndpoint value)
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ClusterEndpoint |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
addClusterEndpoints(ClusterEndpoint.Builder builderForValue)
public Cluster.Builder addClusterEndpoints(ClusterEndpoint.Builder builderForValue)
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
ClusterEndpoint.Builder |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
addClusterEndpoints(int index, ClusterEndpoint value)
public Cluster.Builder addClusterEndpoints(int index, ClusterEndpoint value)
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
ClusterEndpoint |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
addClusterEndpoints(int index, ClusterEndpoint.Builder builderForValue)
public Cluster.Builder addClusterEndpoints(int index, ClusterEndpoint.Builder builderForValue)
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
ClusterEndpoint.Builder |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
addClusterEndpointsBuilder()
public ClusterEndpoint.Builder addClusterEndpointsBuilder()
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ClusterEndpoint.Builder |
addClusterEndpointsBuilder(int index)
public ClusterEndpoint.Builder addClusterEndpointsBuilder(int index)
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
ClusterEndpoint.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)
Optional. 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) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
PscConfig |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
addPscConfigs(PscConfig.Builder builderForValue)
public Cluster.Builder addPscConfigs(PscConfig.Builder builderForValue)
Optional. 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) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
PscConfig.Builder |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
addPscConfigs(int index, PscConfig value)
public Cluster.Builder addPscConfigs(int index, PscConfig value)
Optional. 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) = OPTIONAL];
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)
Optional. 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) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
PscConfig.Builder |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
addPscConfigsBuilder()
public PscConfig.Builder addPscConfigsBuilder()
Optional. 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) = OPTIONAL];
Returns | |
---|---|
Type | Description |
PscConfig.Builder |
addPscConfigsBuilder(int index)
public PscConfig.Builder addPscConfigsBuilder(int index)
Optional. 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) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
PscConfig.Builder |
addPscConnections(PscConnection value)
public Cluster.Builder addPscConnections(PscConnection value)
Output only. The list of PSC connections that are auto-created through service connectivity automation.
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. The list of PSC connections that are auto-created through service connectivity automation.
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. The list of PSC connections that are auto-created through service connectivity automation.
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. The list of PSC connections that are auto-created through service connectivity automation.
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. The list of PSC connections that are auto-created through service connectivity automation.
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. The list of PSC connections that are auto-created through service connectivity automation.
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 |
addPscServiceAttachments(PscServiceAttachment value)
public Cluster.Builder addPscServiceAttachments(PscServiceAttachment value)
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
PscServiceAttachment |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
addPscServiceAttachments(PscServiceAttachment.Builder builderForValue)
public Cluster.Builder addPscServiceAttachments(PscServiceAttachment.Builder builderForValue)
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
PscServiceAttachment.Builder |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
addPscServiceAttachments(int index, PscServiceAttachment value)
public Cluster.Builder addPscServiceAttachments(int index, PscServiceAttachment value)
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
PscServiceAttachment |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
addPscServiceAttachments(int index, PscServiceAttachment.Builder builderForValue)
public Cluster.Builder addPscServiceAttachments(int index, PscServiceAttachment.Builder builderForValue)
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
PscServiceAttachment.Builder |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
addPscServiceAttachmentsBuilder()
public PscServiceAttachment.Builder addPscServiceAttachmentsBuilder()
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
PscServiceAttachment.Builder |
addPscServiceAttachmentsBuilder(int index)
public PscServiceAttachment.Builder addPscServiceAttachmentsBuilder(int index)
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
PscServiceAttachment.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. |
clearAutomatedBackupConfig()
public Cluster.Builder clearAutomatedBackupConfig()
Optional. The automated backup config for the cluster.
.google.cloud.redis.cluster.v1.AutomatedBackupConfig automated_backup_config = 42 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Cluster.Builder |
clearBackupCollection()
public Cluster.Builder clearBackupCollection()
Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
optional string backup_collection = 39 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
Cluster.Builder |
This builder for chaining. |
clearClusterEndpoints()
public Cluster.Builder clearClusterEndpoints()
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Cluster.Builder |
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 |
clearCrossClusterReplicationConfig()
public Cluster.Builder clearCrossClusterReplicationConfig()
Optional. Cross cluster replication config.
.google.cloud.redis.cluster.v1.CrossClusterReplicationConfig cross_cluster_replication_config = 24 [(.google.api.field_behavior) = OPTIONAL];
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 |
clearEncryptionInfo()
public Cluster.Builder clearEncryptionInfo()
Output only. Encryption information of the data at rest of the cluster.
.google.cloud.redis.cluster.v1.EncryptionInfo encryption_info = 43 [(.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 |
clearGcsSource()
public Cluster.Builder clearGcsSource()
Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
.google.cloud.redis.cluster.v1.Cluster.GcsBackupSource gcs_source = 34 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Cluster.Builder |
clearImportSources()
public Cluster.Builder clearImportSources()
Returns | |
---|---|
Type | Description |
Cluster.Builder |
clearKmsKey()
public Cluster.Builder clearKmsKey()
Optional. The KMS key used to encrypt the at-rest data of the cluster.
optional string kms_key = 40 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
Cluster.Builder |
This builder for chaining. |
clearMaintenancePolicy()
public Cluster.Builder clearMaintenancePolicy()
Optional. ClusterMaintenancePolicy determines when to allow or deny updates.
optional .google.cloud.redis.cluster.v1.ClusterMaintenancePolicy maintenance_policy = 26 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Cluster.Builder |
clearMaintenanceSchedule()
public Cluster.Builder clearMaintenanceSchedule()
Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.
optional .google.cloud.redis.cluster.v1.ClusterMaintenanceSchedule maintenance_schedule = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Cluster.Builder |
clearManagedBackupSource()
public Cluster.Builder clearManagedBackupSource()
Optional. Backups generated and managed by memorystore service.
.google.cloud.redis.cluster.v1.Cluster.ManagedBackupSource managed_backup_source = 35 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Cluster.Builder |
clearName()
public Cluster.Builder clearName()
Required. Identifier. 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, (.google.api.field_behavior) = IDENTIFIER];
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()
Optional. 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) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Cluster.Builder |
clearPscConnections()
public Cluster.Builder clearPscConnections()
Output only. The list of PSC connections that are auto-created through service connectivity automation.
repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Cluster.Builder |
clearPscServiceAttachments()
public Cluster.Builder clearPscServiceAttachments()
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.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()
Optional. Number of shards for the Redis cluster.
optional int32 shard_count = 14 [(.google.api.field_behavior) = OPTIONAL];
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. |
getAutomatedBackupConfig()
public AutomatedBackupConfig getAutomatedBackupConfig()
Optional. The automated backup config for the cluster.
.google.cloud.redis.cluster.v1.AutomatedBackupConfig automated_backup_config = 42 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AutomatedBackupConfig |
The automatedBackupConfig. |
getAutomatedBackupConfigBuilder()
public AutomatedBackupConfig.Builder getAutomatedBackupConfigBuilder()
Optional. The automated backup config for the cluster.
.google.cloud.redis.cluster.v1.AutomatedBackupConfig automated_backup_config = 42 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AutomatedBackupConfig.Builder |
getAutomatedBackupConfigOrBuilder()
public AutomatedBackupConfigOrBuilder getAutomatedBackupConfigOrBuilder()
Optional. The automated backup config for the cluster.
.google.cloud.redis.cluster.v1.AutomatedBackupConfig automated_backup_config = 42 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AutomatedBackupConfigOrBuilder |
getBackupCollection()
public String getBackupCollection()
Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
optional string backup_collection = 39 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The backupCollection. |
getBackupCollectionBytes()
public ByteString getBackupCollectionBytes()
Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
optional string backup_collection = 39 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for backupCollection. |
getClusterEndpoints(int index)
public ClusterEndpoint getClusterEndpoints(int index)
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
ClusterEndpoint |
getClusterEndpointsBuilder(int index)
public ClusterEndpoint.Builder getClusterEndpointsBuilder(int index)
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
ClusterEndpoint.Builder |
getClusterEndpointsBuilderList()
public List<ClusterEndpoint.Builder> getClusterEndpointsBuilderList()
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Builder> |
getClusterEndpointsCount()
public int getClusterEndpointsCount()
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getClusterEndpointsList()
public List<ClusterEndpoint> getClusterEndpointsList()
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<ClusterEndpoint> |
getClusterEndpointsOrBuilder(int index)
public ClusterEndpointOrBuilder getClusterEndpointsOrBuilder(int index)
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
ClusterEndpointOrBuilder |
getClusterEndpointsOrBuilderList()
public List<? extends ClusterEndpointOrBuilder> getClusterEndpointsOrBuilderList()
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.redis.cluster.v1.ClusterEndpointOrBuilder> |
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 |
getCrossClusterReplicationConfig()
public CrossClusterReplicationConfig getCrossClusterReplicationConfig()
Optional. Cross cluster replication config.
.google.cloud.redis.cluster.v1.CrossClusterReplicationConfig cross_cluster_replication_config = 24 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
CrossClusterReplicationConfig |
The crossClusterReplicationConfig. |
getCrossClusterReplicationConfigBuilder()
public CrossClusterReplicationConfig.Builder getCrossClusterReplicationConfigBuilder()
Optional. Cross cluster replication config.
.google.cloud.redis.cluster.v1.CrossClusterReplicationConfig cross_cluster_replication_config = 24 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
CrossClusterReplicationConfig.Builder |
getCrossClusterReplicationConfigOrBuilder()
public CrossClusterReplicationConfigOrBuilder getCrossClusterReplicationConfigOrBuilder()
Optional. Cross cluster replication config.
.google.cloud.redis.cluster.v1.CrossClusterReplicationConfig cross_cluster_replication_config = 24 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
CrossClusterReplicationConfigOrBuilder |
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> |
getEncryptionInfo()
public EncryptionInfo getEncryptionInfo()
Output only. Encryption information of the data at rest of the cluster.
.google.cloud.redis.cluster.v1.EncryptionInfo encryption_info = 43 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
EncryptionInfo |
The encryptionInfo. |
getEncryptionInfoBuilder()
public EncryptionInfo.Builder getEncryptionInfoBuilder()
Output only. Encryption information of the data at rest of the cluster.
.google.cloud.redis.cluster.v1.EncryptionInfo encryption_info = 43 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
EncryptionInfo.Builder |
getEncryptionInfoOrBuilder()
public EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()
Output only. Encryption information of the data at rest of the cluster.
.google.cloud.redis.cluster.v1.EncryptionInfo encryption_info = 43 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
EncryptionInfoOrBuilder |
getGcsSource()
public Cluster.GcsBackupSource getGcsSource()
Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
.google.cloud.redis.cluster.v1.Cluster.GcsBackupSource gcs_source = 34 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Cluster.GcsBackupSource |
The gcsSource. |
getGcsSourceBuilder()
public Cluster.GcsBackupSource.Builder getGcsSourceBuilder()
Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
.google.cloud.redis.cluster.v1.Cluster.GcsBackupSource gcs_source = 34 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Cluster.GcsBackupSource.Builder |
getGcsSourceOrBuilder()
public Cluster.GcsBackupSourceOrBuilder getGcsSourceOrBuilder()
Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
.google.cloud.redis.cluster.v1.Cluster.GcsBackupSource gcs_source = 34 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Cluster.GcsBackupSourceOrBuilder |
getImportSourcesCase()
public Cluster.ImportSourcesCase getImportSourcesCase()
Returns | |
---|---|
Type | Description |
Cluster.ImportSourcesCase |
getKmsKey()
public String getKmsKey()
Optional. The KMS key used to encrypt the at-rest data of the cluster.
optional string kms_key = 40 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The kmsKey. |
getKmsKeyBytes()
public ByteString getKmsKeyBytes()
Optional. The KMS key used to encrypt the at-rest data of the cluster.
optional string kms_key = 40 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for kmsKey. |
getMaintenancePolicy()
public ClusterMaintenancePolicy getMaintenancePolicy()
Optional. ClusterMaintenancePolicy determines when to allow or deny updates.
optional .google.cloud.redis.cluster.v1.ClusterMaintenancePolicy maintenance_policy = 26 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ClusterMaintenancePolicy |
The maintenancePolicy. |
getMaintenancePolicyBuilder()
public ClusterMaintenancePolicy.Builder getMaintenancePolicyBuilder()
Optional. ClusterMaintenancePolicy determines when to allow or deny updates.
optional .google.cloud.redis.cluster.v1.ClusterMaintenancePolicy maintenance_policy = 26 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ClusterMaintenancePolicy.Builder |
getMaintenancePolicyOrBuilder()
public ClusterMaintenancePolicyOrBuilder getMaintenancePolicyOrBuilder()
Optional. ClusterMaintenancePolicy determines when to allow or deny updates.
optional .google.cloud.redis.cluster.v1.ClusterMaintenancePolicy maintenance_policy = 26 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ClusterMaintenancePolicyOrBuilder |
getMaintenanceSchedule()
public ClusterMaintenanceSchedule getMaintenanceSchedule()
Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.
optional .google.cloud.redis.cluster.v1.ClusterMaintenanceSchedule maintenance_schedule = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ClusterMaintenanceSchedule |
The maintenanceSchedule. |
getMaintenanceScheduleBuilder()
public ClusterMaintenanceSchedule.Builder getMaintenanceScheduleBuilder()
Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.
optional .google.cloud.redis.cluster.v1.ClusterMaintenanceSchedule maintenance_schedule = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ClusterMaintenanceSchedule.Builder |
getMaintenanceScheduleOrBuilder()
public ClusterMaintenanceScheduleOrBuilder getMaintenanceScheduleOrBuilder()
Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.
optional .google.cloud.redis.cluster.v1.ClusterMaintenanceSchedule maintenance_schedule = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ClusterMaintenanceScheduleOrBuilder |
getManagedBackupSource()
public Cluster.ManagedBackupSource getManagedBackupSource()
Optional. Backups generated and managed by memorystore service.
.google.cloud.redis.cluster.v1.Cluster.ManagedBackupSource managed_backup_source = 35 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Cluster.ManagedBackupSource |
The managedBackupSource. |
getManagedBackupSourceBuilder()
public Cluster.ManagedBackupSource.Builder getManagedBackupSourceBuilder()
Optional. Backups generated and managed by memorystore service.
.google.cloud.redis.cluster.v1.Cluster.ManagedBackupSource managed_backup_source = 35 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Cluster.ManagedBackupSource.Builder |
getManagedBackupSourceOrBuilder()
public Cluster.ManagedBackupSourceOrBuilder getManagedBackupSourceOrBuilder()
Optional. Backups generated and managed by memorystore service.
.google.cloud.redis.cluster.v1.Cluster.ManagedBackupSource managed_backup_source = 35 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Cluster.ManagedBackupSourceOrBuilder |
getMutableRedisConfigs() (deprecated)
public Map<String,String> getMutableRedisConfigs()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getName()
public String getName()
Required. Identifier. 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, (.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
Required. Identifier. 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, (.google.api.field_behavior) = IDENTIFIER];
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)
Optional. 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) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
PscConfig |
getPscConfigsBuilder(int index)
public PscConfig.Builder getPscConfigsBuilder(int index)
Optional. 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) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
PscConfig.Builder |
getPscConfigsBuilderList()
public List<PscConfig.Builder> getPscConfigsBuilderList()
Optional. 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) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Builder> |
getPscConfigsCount()
public int getPscConfigsCount()
Optional. 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) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getPscConfigsList()
public List<PscConfig> getPscConfigsList()
Optional. 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) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<PscConfig> |
getPscConfigsOrBuilder(int index)
public PscConfigOrBuilder getPscConfigsOrBuilder(int index)
Optional. 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) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
PscConfigOrBuilder |
getPscConfigsOrBuilderList()
public List<? extends PscConfigOrBuilder> getPscConfigsOrBuilderList()
Optional. 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) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.redis.cluster.v1.PscConfigOrBuilder> |
getPscConnections(int index)
public PscConnection getPscConnections(int index)
Output only. The list of PSC connections that are auto-created through service connectivity automation.
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. The list of PSC connections that are auto-created through service connectivity automation.
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. The list of PSC connections that are auto-created through service connectivity automation.
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. The list of PSC connections that are auto-created through service connectivity automation.
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. The list of PSC connections that are auto-created through service connectivity automation.
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. The list of PSC connections that are auto-created through service connectivity automation.
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. The list of PSC connections that are auto-created through service connectivity automation.
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> |
getPscServiceAttachments(int index)
public PscServiceAttachment getPscServiceAttachments(int index)
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
PscServiceAttachment |
getPscServiceAttachmentsBuilder(int index)
public PscServiceAttachment.Builder getPscServiceAttachmentsBuilder(int index)
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
PscServiceAttachment.Builder |
getPscServiceAttachmentsBuilderList()
public List<PscServiceAttachment.Builder> getPscServiceAttachmentsBuilderList()
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<Builder> |
getPscServiceAttachmentsCount()
public int getPscServiceAttachmentsCount()
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int |
getPscServiceAttachmentsList()
public List<PscServiceAttachment> getPscServiceAttachmentsList()
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<PscServiceAttachment> |
getPscServiceAttachmentsOrBuilder(int index)
public PscServiceAttachmentOrBuilder getPscServiceAttachmentsOrBuilder(int index)
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
PscServiceAttachmentOrBuilder |
getPscServiceAttachmentsOrBuilderList()
public List<? extends PscServiceAttachmentOrBuilder> getPscServiceAttachmentsOrBuilderList()
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.redis.cluster.v1.PscServiceAttachmentOrBuilder> |
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()
Optional. Number of shards for the Redis cluster.
optional int32 shard_count = 14 [(.google.api.field_behavior) = OPTIONAL];
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 |
hasAutomatedBackupConfig()
public boolean hasAutomatedBackupConfig()
Optional. The automated backup config for the cluster.
.google.cloud.redis.cluster.v1.AutomatedBackupConfig automated_backup_config = 42 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the automatedBackupConfig field is set. |
hasBackupCollection()
public boolean hasBackupCollection()
Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
optional string backup_collection = 39 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
boolean |
Whether the backupCollection field is set. |
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. |
hasCrossClusterReplicationConfig()
public boolean hasCrossClusterReplicationConfig()
Optional. Cross cluster replication config.
.google.cloud.redis.cluster.v1.CrossClusterReplicationConfig cross_cluster_replication_config = 24 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the crossClusterReplicationConfig 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. |
hasEncryptionInfo()
public boolean hasEncryptionInfo()
Output only. Encryption information of the data at rest of the cluster.
.google.cloud.redis.cluster.v1.EncryptionInfo encryption_info = 43 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the encryptionInfo field is set. |
hasGcsSource()
public boolean hasGcsSource()
Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
.google.cloud.redis.cluster.v1.Cluster.GcsBackupSource gcs_source = 34 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the gcsSource field is set. |
hasKmsKey()
public boolean hasKmsKey()
Optional. The KMS key used to encrypt the at-rest data of the cluster.
optional string kms_key = 40 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
boolean |
Whether the kmsKey field is set. |
hasMaintenancePolicy()
public boolean hasMaintenancePolicy()
Optional. ClusterMaintenancePolicy determines when to allow or deny updates.
optional .google.cloud.redis.cluster.v1.ClusterMaintenancePolicy maintenance_policy = 26 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the maintenancePolicy field is set. |
hasMaintenanceSchedule()
public boolean hasMaintenanceSchedule()
Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.
optional .google.cloud.redis.cluster.v1.ClusterMaintenanceSchedule maintenance_schedule = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the maintenanceSchedule field is set. |
hasManagedBackupSource()
public boolean hasManagedBackupSource()
Optional. Backups generated and managed by memorystore service.
.google.cloud.redis.cluster.v1.Cluster.ManagedBackupSource managed_backup_source = 35 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the managedBackupSource 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()
Optional. Number of shards for the Redis cluster.
optional int32 shard_count = 14 [(.google.api.field_behavior) = OPTIONAL];
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 |
mergeAutomatedBackupConfig(AutomatedBackupConfig value)
public Cluster.Builder mergeAutomatedBackupConfig(AutomatedBackupConfig value)
Optional. The automated backup config for the cluster.
.google.cloud.redis.cluster.v1.AutomatedBackupConfig automated_backup_config = 42 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
AutomatedBackupConfig |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
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 |
mergeCrossClusterReplicationConfig(CrossClusterReplicationConfig value)
public Cluster.Builder mergeCrossClusterReplicationConfig(CrossClusterReplicationConfig value)
Optional. Cross cluster replication config.
.google.cloud.redis.cluster.v1.CrossClusterReplicationConfig cross_cluster_replication_config = 24 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
CrossClusterReplicationConfig |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
mergeEncryptionInfo(EncryptionInfo value)
public Cluster.Builder mergeEncryptionInfo(EncryptionInfo value)
Output only. Encryption information of the data at rest of the cluster.
.google.cloud.redis.cluster.v1.EncryptionInfo encryption_info = 43 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
EncryptionInfo |
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 |
mergeGcsSource(Cluster.GcsBackupSource value)
public Cluster.Builder mergeGcsSource(Cluster.GcsBackupSource value)
Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
.google.cloud.redis.cluster.v1.Cluster.GcsBackupSource gcs_source = 34 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Cluster.GcsBackupSource |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
mergeMaintenancePolicy(ClusterMaintenancePolicy value)
public Cluster.Builder mergeMaintenancePolicy(ClusterMaintenancePolicy value)
Optional. ClusterMaintenancePolicy determines when to allow or deny updates.
optional .google.cloud.redis.cluster.v1.ClusterMaintenancePolicy maintenance_policy = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ClusterMaintenancePolicy |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
mergeMaintenanceSchedule(ClusterMaintenanceSchedule value)
public Cluster.Builder mergeMaintenanceSchedule(ClusterMaintenanceSchedule value)
Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.
optional .google.cloud.redis.cluster.v1.ClusterMaintenanceSchedule maintenance_schedule = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ClusterMaintenanceSchedule |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
mergeManagedBackupSource(Cluster.ManagedBackupSource value)
public Cluster.Builder mergeManagedBackupSource(Cluster.ManagedBackupSource value)
Optional. Backups generated and managed by memorystore service.
.google.cloud.redis.cluster.v1.Cluster.ManagedBackupSource managed_backup_source = 35 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Cluster.ManagedBackupSource |
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 |
removeClusterEndpoints(int index)
public Cluster.Builder removeClusterEndpoints(int index)
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
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)
Optional. 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) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
removePscConnections(int index)
public Cluster.Builder removePscConnections(int index)
Output only. The list of PSC connections that are auto-created through service connectivity automation.
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 |
removePscServiceAttachments(int index)
public Cluster.Builder removePscServiceAttachments(int index)
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.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 |
AuthorizationMode The 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 |
int The enum numeric value on the wire for authorizationMode to set. |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
This builder for chaining. |
setAutomatedBackupConfig(AutomatedBackupConfig value)
public Cluster.Builder setAutomatedBackupConfig(AutomatedBackupConfig value)
Optional. The automated backup config for the cluster.
.google.cloud.redis.cluster.v1.AutomatedBackupConfig automated_backup_config = 42 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
AutomatedBackupConfig |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
setAutomatedBackupConfig(AutomatedBackupConfig.Builder builderForValue)
public Cluster.Builder setAutomatedBackupConfig(AutomatedBackupConfig.Builder builderForValue)
Optional. The automated backup config for the cluster.
.google.cloud.redis.cluster.v1.AutomatedBackupConfig automated_backup_config = 42 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
AutomatedBackupConfig.Builder |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
setBackupCollection(String value)
public Cluster.Builder setBackupCollection(String value)
Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
optional string backup_collection = 39 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The backupCollection to set. |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
This builder for chaining. |
setBackupCollectionBytes(ByteString value)
public Cluster.Builder setBackupCollectionBytes(ByteString value)
Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
optional string backup_collection = 39 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for backupCollection to set. |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
This builder for chaining. |
setClusterEndpoints(int index, ClusterEndpoint value)
public Cluster.Builder setClusterEndpoints(int index, ClusterEndpoint value)
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
ClusterEndpoint |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
setClusterEndpoints(int index, ClusterEndpoint.Builder builderForValue)
public Cluster.Builder setClusterEndpoints(int index, ClusterEndpoint.Builder builderForValue)
Optional. A list of cluster enpoints.
repeated .google.cloud.redis.cluster.v1.ClusterEndpoint cluster_endpoints = 36 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
ClusterEndpoint.Builder |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
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 |
setCrossClusterReplicationConfig(CrossClusterReplicationConfig value)
public Cluster.Builder setCrossClusterReplicationConfig(CrossClusterReplicationConfig value)
Optional. Cross cluster replication config.
.google.cloud.redis.cluster.v1.CrossClusterReplicationConfig cross_cluster_replication_config = 24 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
CrossClusterReplicationConfig |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
setCrossClusterReplicationConfig(CrossClusterReplicationConfig.Builder builderForValue)
public Cluster.Builder setCrossClusterReplicationConfig(CrossClusterReplicationConfig.Builder builderForValue)
Optional. Cross cluster replication config.
.google.cloud.redis.cluster.v1.CrossClusterReplicationConfig cross_cluster_replication_config = 24 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
CrossClusterReplicationConfig.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 |
boolean The 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 |
setEncryptionInfo(EncryptionInfo value)
public Cluster.Builder setEncryptionInfo(EncryptionInfo value)
Output only. Encryption information of the data at rest of the cluster.
.google.cloud.redis.cluster.v1.EncryptionInfo encryption_info = 43 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
EncryptionInfo |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
setEncryptionInfo(EncryptionInfo.Builder builderForValue)
public Cluster.Builder setEncryptionInfo(EncryptionInfo.Builder builderForValue)
Output only. Encryption information of the data at rest of the cluster.
.google.cloud.redis.cluster.v1.EncryptionInfo encryption_info = 43 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
EncryptionInfo.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 |
setGcsSource(Cluster.GcsBackupSource value)
public Cluster.Builder setGcsSource(Cluster.GcsBackupSource value)
Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
.google.cloud.redis.cluster.v1.Cluster.GcsBackupSource gcs_source = 34 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Cluster.GcsBackupSource |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
setGcsSource(Cluster.GcsBackupSource.Builder builderForValue)
public Cluster.Builder setGcsSource(Cluster.GcsBackupSource.Builder builderForValue)
Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
.google.cloud.redis.cluster.v1.Cluster.GcsBackupSource gcs_source = 34 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
Cluster.GcsBackupSource.Builder |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
setKmsKey(String value)
public Cluster.Builder setKmsKey(String value)
Optional. The KMS key used to encrypt the at-rest data of the cluster.
optional string kms_key = 40 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The kmsKey to set. |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
This builder for chaining. |
setKmsKeyBytes(ByteString value)
public Cluster.Builder setKmsKeyBytes(ByteString value)
Optional. The KMS key used to encrypt the at-rest data of the cluster.
optional string kms_key = 40 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for kmsKey to set. |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
This builder for chaining. |
setMaintenancePolicy(ClusterMaintenancePolicy value)
public Cluster.Builder setMaintenancePolicy(ClusterMaintenancePolicy value)
Optional. ClusterMaintenancePolicy determines when to allow or deny updates.
optional .google.cloud.redis.cluster.v1.ClusterMaintenancePolicy maintenance_policy = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ClusterMaintenancePolicy |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
setMaintenancePolicy(ClusterMaintenancePolicy.Builder builderForValue)
public Cluster.Builder setMaintenancePolicy(ClusterMaintenancePolicy.Builder builderForValue)
Optional. ClusterMaintenancePolicy determines when to allow or deny updates.
optional .google.cloud.redis.cluster.v1.ClusterMaintenancePolicy maintenance_policy = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
ClusterMaintenancePolicy.Builder |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
setMaintenanceSchedule(ClusterMaintenanceSchedule value)
public Cluster.Builder setMaintenanceSchedule(ClusterMaintenanceSchedule value)
Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.
optional .google.cloud.redis.cluster.v1.ClusterMaintenanceSchedule maintenance_schedule = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ClusterMaintenanceSchedule |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
setMaintenanceSchedule(ClusterMaintenanceSchedule.Builder builderForValue)
public Cluster.Builder setMaintenanceSchedule(ClusterMaintenanceSchedule.Builder builderForValue)
Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.
optional .google.cloud.redis.cluster.v1.ClusterMaintenanceSchedule maintenance_schedule = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
ClusterMaintenanceSchedule.Builder |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
setManagedBackupSource(Cluster.ManagedBackupSource value)
public Cluster.Builder setManagedBackupSource(Cluster.ManagedBackupSource value)
Optional. Backups generated and managed by memorystore service.
.google.cloud.redis.cluster.v1.Cluster.ManagedBackupSource managed_backup_source = 35 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Cluster.ManagedBackupSource |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
setManagedBackupSource(Cluster.ManagedBackupSource.Builder builderForValue)
public Cluster.Builder setManagedBackupSource(Cluster.ManagedBackupSource.Builder builderForValue)
Optional. Backups generated and managed by memorystore service.
.google.cloud.redis.cluster.v1.Cluster.ManagedBackupSource managed_backup_source = 35 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
Cluster.ManagedBackupSource.Builder |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
setName(String value)
public Cluster.Builder setName(String value)
Required. Identifier. 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, (.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Cluster.Builder setNameBytes(ByteString value)
Required. Identifier. 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, (.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
ByteString The 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 |
NodeType The 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 |
int The 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 |
double The 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)
Optional. 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) = OPTIONAL];
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)
Optional. 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) = OPTIONAL];
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. The list of PSC connections that are auto-created through service connectivity automation.
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. The list of PSC connections that are auto-created through service connectivity automation.
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 |
setPscServiceAttachments(int index, PscServiceAttachment value)
public Cluster.Builder setPscServiceAttachments(int index, PscServiceAttachment value)
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
PscServiceAttachment |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
setPscServiceAttachments(int index, PscServiceAttachment.Builder builderForValue)
public Cluster.Builder setPscServiceAttachments(int index, PscServiceAttachment.Builder builderForValue)
Output only. Service attachment details to configure Psc connections
repeated .google.cloud.redis.cluster.v1.PscServiceAttachment psc_service_attachments = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
PscServiceAttachment.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 |
int The replicaCount to set. |
Returns | |
---|---|
Type | Description |
Cluster.Builder |
This builder for chaining. |
setShardCount(int value)
public Cluster.Builder setShardCount(int value)
Optional. Number of shards for the Redis cluster.
optional int32 shard_count = 14 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
int The 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 |
int The 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.State The 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 |
int The 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 |
TransitEncryptionMode The 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 |
int The 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 |
String The 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 |
ByteString The 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 |