Class Cluster (0.29.0)

public final class Cluster extends GeneratedMessageV3 implements ClusterOrBuilder

A cluster instance.

Protobuf type google.cloud.redis.cluster.v1.Cluster

Implements

ClusterOrBuilder

Static Fields

AUTHORIZATION_MODE_FIELD_NUMBER

public static final int AUTHORIZATION_MODE_FIELD_NUMBER
Field Value
Type Description
int

AUTOMATED_BACKUP_CONFIG_FIELD_NUMBER

public static final int AUTOMATED_BACKUP_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_COLLECTION_FIELD_NUMBER

public static final int BACKUP_COLLECTION_FIELD_NUMBER
Field Value
Type Description
int

CLUSTER_ENDPOINTS_FIELD_NUMBER

public static final int CLUSTER_ENDPOINTS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CROSS_CLUSTER_REPLICATION_CONFIG_FIELD_NUMBER

public static final int CROSS_CLUSTER_REPLICATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

DELETION_PROTECTION_ENABLED_FIELD_NUMBER

public static final int DELETION_PROTECTION_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

DISCOVERY_ENDPOINTS_FIELD_NUMBER

public static final int DISCOVERY_ENDPOINTS_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTION_INFO_FIELD_NUMBER

public static final int ENCRYPTION_INFO_FIELD_NUMBER
Field Value
Type Description
int

GCS_SOURCE_FIELD_NUMBER

public static final int GCS_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
Type Description
int

MAINTENANCE_POLICY_FIELD_NUMBER

public static final int MAINTENANCE_POLICY_FIELD_NUMBER
Field Value
Type Description
int

MAINTENANCE_SCHEDULE_FIELD_NUMBER

public static final int MAINTENANCE_SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

MANAGED_BACKUP_SOURCE_FIELD_NUMBER

public static final int MANAGED_BACKUP_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NODE_TYPE_FIELD_NUMBER

public static final int NODE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PERSISTENCE_CONFIG_FIELD_NUMBER

public static final int PERSISTENCE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PRECISE_SIZE_GB_FIELD_NUMBER

public static final int PRECISE_SIZE_GB_FIELD_NUMBER
Field Value
Type Description
int

PSC_CONFIGS_FIELD_NUMBER

public static final int PSC_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

PSC_CONNECTIONS_FIELD_NUMBER

public static final int PSC_CONNECTIONS_FIELD_NUMBER
Field Value
Type Description
int

PSC_SERVICE_ATTACHMENTS_FIELD_NUMBER

public static final int PSC_SERVICE_ATTACHMENTS_FIELD_NUMBER
Field Value
Type Description
int

REDIS_CONFIGS_FIELD_NUMBER

public static final int REDIS_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

REPLICA_COUNT_FIELD_NUMBER

public static final int REPLICA_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SHARD_COUNT_FIELD_NUMBER

public static final int SHARD_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SIZE_GB_FIELD_NUMBER

public static final int SIZE_GB_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STATE_INFO_FIELD_NUMBER

public static final int STATE_INFO_FIELD_NUMBER
Field Value
Type Description
int

TRANSIT_ENCRYPTION_MODE_FIELD_NUMBER

public static final int TRANSIT_ENCRYPTION_MODE_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

ZONE_DISTRIBUTION_CONFIG_FIELD_NUMBER

public static final int ZONE_DISTRIBUTION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Cluster getDefaultInstance()
Returns
Type Description
Cluster

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Cluster.Builder newBuilder()
Returns
Type Description
Cluster.Builder

newBuilder(Cluster prototype)

public static Cluster.Builder newBuilder(Cluster prototype)
Parameter
Name Description
prototype Cluster
Returns
Type Description
Cluster.Builder

parseDelimitedFrom(InputStream input)

public static Cluster parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Cluster parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Cluster parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Cluster parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Cluster parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Cluster parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Cluster> parser()
Returns
Type Description
Parser<Cluster>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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

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.

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.

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.

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

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.

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.

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.

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.

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.

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

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.

getParserForType()

public Parser<Cluster> getParserForType()
Returns
Type Description
Parser<Cluster>
Overrides

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.

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

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

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Cluster.Builder newBuilderForType()
Returns
Type Description
Cluster.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Cluster.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Cluster.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Cluster.Builder toBuilder()
Returns
Type Description
Cluster.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException