com.google.cloud.redis.cluster.v1.ClusterOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-redis-cluster-v1 Show documentation
Show all versions of proto-google-cloud-redis-cluster-v1 Show documentation
Proto library for google-cloud-redis-cluster
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/redis/cluster/v1/cloud_redis_cluster.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.redis.cluster.v1;
public interface ClusterOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.redis.cluster.v1.Cluster)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. Unique name of the resource in this scope including project and
* location using the form:
* `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`
*
*
* string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Required. Unique name of the resource in this scope including project and
* location using the form:
* `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`
*
*
* string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. The timestamp associated with the cluster creation request.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The timestamp associated with the cluster creation request.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The timestamp associated with the cluster creation request.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* 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];
*
*
* @return The enum numeric value on the wire for state.
*/
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];
*
*
* @return The state.
*/
com.google.cloud.redis.cluster.v1.Cluster.State getState();
/**
*
*
*
* Output only. System assigned, unique identifier for the cluster.
*
*
* string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The uid.
*/
java.lang.String getUid();
/**
*
*
*
* Output only. System assigned, unique identifier for the cluster.
*
*
* string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for uid.
*/
com.google.protobuf.ByteString getUidBytes();
/**
*
*
*
* Optional. The number of replica nodes per shard.
*
*
* optional int32 replica_count = 8 [(.google.api.field_behavior) = OPTIONAL];
*
* @return Whether the replicaCount field is set.
*/
boolean hasReplicaCount();
/**
*
*
*
* Optional. The number of replica nodes per shard.
*
*
* optional int32 replica_count = 8 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The replicaCount.
*/
int getReplicaCount();
/**
*
*
*
* 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];
*
*
* @return The enum numeric value on the wire for authorizationMode.
*/
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];
*
*
* @return The authorizationMode.
*/
com.google.cloud.redis.cluster.v1.AuthorizationMode getAuthorizationMode();
/**
*
*
*
* 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];
*
*
* @return The enum numeric value on the wire for transitEncryptionMode.
*/
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];
*
*
* @return The transitEncryptionMode.
*/
com.google.cloud.redis.cluster.v1.TransitEncryptionMode getTransitEncryptionMode();
/**
*
*
*
* 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];
*
* @return Whether the sizeGb field is set.
*/
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];
*
* @return The sizeGb.
*/
int getSizeGb();
/**
*
*
*
* Required. Number of shards for the Redis cluster.
*
*
* optional int32 shard_count = 14 [(.google.api.field_behavior) = REQUIRED];
*
* @return Whether the shardCount field is set.
*/
boolean hasShardCount();
/**
*
*
*
* Required. Number of shards for the Redis cluster.
*
*
* optional int32 shard_count = 14 [(.google.api.field_behavior) = REQUIRED];
*
* @return The shardCount.
*/
int getShardCount();
/**
*
*
*
* Required. Each PscConfig configures the consumer network where IPs will
* be designated to the cluster for client access through Private Service
* Connect Automation. Currently, only one PscConfig is supported.
*
*
*
* repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];
*
*/
java.util.List getPscConfigsList();
/**
*
*
*
* Required. Each PscConfig configures the consumer network where IPs will
* be designated to the cluster for client access through Private Service
* Connect Automation. Currently, only one PscConfig is supported.
*
*
*
* repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.redis.cluster.v1.PscConfig getPscConfigs(int index);
/**
*
*
*
* Required. Each PscConfig configures the consumer network where IPs will
* be designated to the cluster for client access through Private Service
* Connect Automation. Currently, only one PscConfig is supported.
*
*
*
* repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];
*
*/
int getPscConfigsCount();
/**
*
*
*
* Required. Each PscConfig configures the consumer network where IPs will
* be designated to the cluster for client access through Private Service
* Connect Automation. Currently, only one PscConfig is supported.
*
*
*
* repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];
*
*/
java.util.List
getPscConfigsOrBuilderList();
/**
*
*
*
* Required. Each PscConfig configures the consumer network where IPs will
* be designated to the cluster for client access through Private Service
* Connect Automation. Currently, only one PscConfig is supported.
*
*
*
* repeated .google.cloud.redis.cluster.v1.PscConfig psc_configs = 15 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.redis.cluster.v1.PscConfigOrBuilder getPscConfigsOrBuilder(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];
*
*/
java.util.List 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];
*
*/
com.google.cloud.redis.cluster.v1.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.redis.cluster.v1.DiscoveryEndpointOrBuilder getDiscoveryEndpointsOrBuilder(
int index);
/**
*
*
*
* Output only. PSC connections for discovery of the cluster topology and
* accessing the cluster.
*
*
*
* repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List getPscConnectionsList();
/**
*
*
*
* Output only. PSC connections for discovery of the cluster topology and
* accessing the cluster.
*
*
*
* repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.redis.cluster.v1.PscConnection getPscConnections(int index);
/**
*
*
*
* Output only. PSC connections for discovery of the cluster topology and
* accessing the cluster.
*
*
*
* repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
int getPscConnectionsCount();
/**
*
*
*
* Output only. PSC connections for discovery of the cluster topology and
* accessing the cluster.
*
*
*
* repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List
getPscConnectionsOrBuilderList();
/**
*
*
*
* Output only. PSC connections for discovery of the cluster topology and
* accessing the cluster.
*
*
*
* repeated .google.cloud.redis.cluster.v1.PscConnection psc_connections = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.redis.cluster.v1.PscConnectionOrBuilder getPscConnectionsOrBuilder(int index);
/**
*
*
*
* 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];
*
*
* @return Whether the stateInfo field is set.
*/
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];
*
*
* @return The stateInfo.
*/
com.google.cloud.redis.cluster.v1.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];
*
*/
com.google.cloud.redis.cluster.v1.Cluster.StateInfoOrBuilder getStateInfoOrBuilder();
/**
*
*
*
* 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];
*
*
* @return The enum numeric value on the wire for nodeType.
*/
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];
*
*
* @return The nodeType.
*/
com.google.cloud.redis.cluster.v1.NodeType getNodeType();
/**
*
*
*
* Optional. Persistence config (RDB, AOF) for the cluster.
*
*
*
* .google.cloud.redis.cluster.v1.ClusterPersistenceConfig persistence_config = 20 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the persistenceConfig field is set.
*/
boolean hasPersistenceConfig();
/**
*
*
*
* Optional. Persistence config (RDB, AOF) for the cluster.
*
*
*
* .google.cloud.redis.cluster.v1.ClusterPersistenceConfig persistence_config = 20 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The persistenceConfig.
*/
com.google.cloud.redis.cluster.v1.ClusterPersistenceConfig getPersistenceConfig();
/**
*
*
*
* Optional. Persistence config (RDB, AOF) for the cluster.
*
*
*
* .google.cloud.redis.cluster.v1.ClusterPersistenceConfig persistence_config = 20 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.redis.cluster.v1.ClusterPersistenceConfigOrBuilder
getPersistenceConfigOrBuilder();
/**
*
*
*
* Optional. Key/Value pairs of customer overrides for mutable Redis Configs
*
*
* map<string, string> redis_configs = 21 [(.google.api.field_behavior) = OPTIONAL];
*
*/
int getRedisConfigsCount();
/**
*
*
*
* Optional. Key/Value pairs of customer overrides for mutable Redis Configs
*
*
* map<string, string> redis_configs = 21 [(.google.api.field_behavior) = OPTIONAL];
*
*/
boolean containsRedisConfigs(java.lang.String key);
/** Use {@link #getRedisConfigsMap()} instead. */
@java.lang.Deprecated
java.util.Map getRedisConfigs();
/**
*
*
*
* Optional. Key/Value pairs of customer overrides for mutable Redis Configs
*
*
* map<string, string> redis_configs = 21 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.Map getRedisConfigsMap();
/**
*
*
*
* Optional. Key/Value pairs of customer overrides for mutable Redis Configs
*
*
* map<string, string> redis_configs = 21 [(.google.api.field_behavior) = OPTIONAL];
*
*/
/* nullable */
java.lang.String getRedisConfigsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Optional. Key/Value pairs of customer overrides for mutable Redis Configs
*
*
* map<string, string> redis_configs = 21 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.lang.String getRedisConfigsOrThrow(java.lang.String key);
/**
*
*
*
* 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];
*
* @return Whether the preciseSizeGb field is set.
*/
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];
*
* @return The preciseSizeGb.
*/
double getPreciseSizeGb();
/**
*
*
*
* 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];
*
*
* @return Whether the zoneDistributionConfig field is set.
*/
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];
*
*
* @return The zoneDistributionConfig.
*/
com.google.cloud.redis.cluster.v1.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];
*
*/
com.google.cloud.redis.cluster.v1.ZoneDistributionConfigOrBuilder
getZoneDistributionConfigOrBuilder();
/**
*
*
*
* Optional. The delete operation will fail when the value is set to true.
*
*
* optional bool deletion_protection_enabled = 25 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the deletionProtectionEnabled field is set.
*/
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];
*
*
* @return The deletionProtectionEnabled.
*/
boolean getDeletionProtectionEnabled();
}