public final class Instance extends com.google.protobuf.GeneratedMessageV3 implements InstanceOrBuilder
A Memorystore for Redis instance.Protobuf type
google.cloud.redis.v1.Instance| Modifier and Type | Class and Description |
|---|---|
static class |
Instance.Builder
A Memorystore for Redis instance.
|
static class |
Instance.ConnectMode
Available connection modes.
|
static class |
Instance.ReadReplicasMode
Read replicas mode.
|
static class |
Instance.State
Represents the different states of a Redis instance.
|
static class |
Instance.SuspensionReason
Possible reasons for the instance to be in a "SUSPENDED" state.
|
static class |
Instance.Tier
Available service tiers to choose from
|
static class |
Instance.TransitEncryptionMode
Available TLS modes.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
Resource labels to represent user provided metadata
|
boolean |
containsRedisConfigs(String key)
Optional.
|
boolean |
equals(Object obj) |
String |
getAlternativeLocationId()
Optional.
|
com.google.protobuf.ByteString |
getAlternativeLocationIdBytes()
Optional.
|
boolean |
getAuthEnabled()
Optional.
|
String |
getAuthorizedNetwork()
Optional.
|
com.google.protobuf.ByteString |
getAuthorizedNetworkBytes()
Optional.
|
String |
getAvailableMaintenanceVersions(int index)
Optional.
|
com.google.protobuf.ByteString |
getAvailableMaintenanceVersionsBytes(int index)
Optional.
|
int |
getAvailableMaintenanceVersionsCount()
Optional.
|
com.google.protobuf.ProtocolStringList |
getAvailableMaintenanceVersionsList()
Optional.
|
Instance.ConnectMode |
getConnectMode()
Optional.
|
int |
getConnectModeValue()
Optional.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
String |
getCurrentLocationId()
Output only.
|
com.google.protobuf.ByteString |
getCurrentLocationIdBytes()
Output only.
|
String |
getCustomerManagedKey()
Optional.
|
com.google.protobuf.ByteString |
getCustomerManagedKeyBytes()
Optional.
|
static Instance |
getDefaultInstance() |
Instance |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
An arbitrary and optional user-provided name for the instance.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
An arbitrary and optional user-provided name for the instance.
|
String |
getHost()
Output only.
|
com.google.protobuf.ByteString |
getHostBytes()
Output only.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
Resource labels to represent user provided metadata
|
Map<String,String> |
getLabelsMap()
Resource labels to represent user provided metadata
|
String |
getLabelsOrDefault(String key,
String defaultValue)
Resource labels to represent user provided metadata
|
String |
getLabelsOrThrow(String key)
Resource labels to represent user provided metadata
|
String |
getLocationId()
Optional.
|
com.google.protobuf.ByteString |
getLocationIdBytes()
Optional.
|
MaintenancePolicy |
getMaintenancePolicy()
Optional.
|
MaintenancePolicyOrBuilder |
getMaintenancePolicyOrBuilder()
Optional.
|
MaintenanceSchedule |
getMaintenanceSchedule()
Output only.
|
MaintenanceScheduleOrBuilder |
getMaintenanceScheduleOrBuilder()
Output only.
|
String |
getMaintenanceVersion()
Optional.
|
com.google.protobuf.ByteString |
getMaintenanceVersionBytes()
Optional.
|
int |
getMemorySizeGb()
Required.
|
String |
getName()
Required.
|
com.google.protobuf.ByteString |
getNameBytes()
Required.
|
NodeInfo |
getNodes(int index)
Output only.
|
int |
getNodesCount()
Output only.
|
List<NodeInfo> |
getNodesList()
Output only.
|
NodeInfoOrBuilder |
getNodesOrBuilder(int index)
Output only.
|
List<? extends NodeInfoOrBuilder> |
getNodesOrBuilderList()
Output only.
|
com.google.protobuf.Parser<Instance> |
getParserForType() |
PersistenceConfig |
getPersistenceConfig()
Optional.
|
PersistenceConfigOrBuilder |
getPersistenceConfigOrBuilder()
Optional.
|
String |
getPersistenceIamIdentity()
Output only.
|
com.google.protobuf.ByteString |
getPersistenceIamIdentityBytes()
Output only.
|
int |
getPort()
Output only.
|
String |
getReadEndpoint()
Output only.
|
com.google.protobuf.ByteString |
getReadEndpointBytes()
Output only.
|
int |
getReadEndpointPort()
Output only.
|
Instance.ReadReplicasMode |
getReadReplicasMode()
Optional.
|
int |
getReadReplicasModeValue()
Optional.
|
Map<String,String> |
getRedisConfigs()
Deprecated.
|
int |
getRedisConfigsCount()
Optional.
|
Map<String,String> |
getRedisConfigsMap()
Optional.
|
String |
getRedisConfigsOrDefault(String key,
String defaultValue)
Optional.
|
String |
getRedisConfigsOrThrow(String key)
Optional.
|
String |
getRedisVersion()
Optional.
|
com.google.protobuf.ByteString |
getRedisVersionBytes()
Optional.
|
int |
getReplicaCount()
Optional.
|
String |
getReservedIpRange()
Optional.
|
com.google.protobuf.ByteString |
getReservedIpRangeBytes()
Optional.
|
String |
getSecondaryIpRange()
Optional.
|
com.google.protobuf.ByteString |
getSecondaryIpRangeBytes()
Optional.
|
int |
getSerializedSize() |
TlsCertificate |
getServerCaCerts(int index)
Output only.
|
int |
getServerCaCertsCount()
Output only.
|
List<TlsCertificate> |
getServerCaCertsList()
Output only.
|
TlsCertificateOrBuilder |
getServerCaCertsOrBuilder(int index)
Output only.
|
List<? extends TlsCertificateOrBuilder> |
getServerCaCertsOrBuilderList()
Output only.
|
Instance.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
String |
getStatusMessage()
Output only.
|
com.google.protobuf.ByteString |
getStatusMessageBytes()
Output only.
|
Instance.SuspensionReason |
getSuspensionReasons(int index)
Optional.
|
int |
getSuspensionReasonsCount()
Optional.
|
List<Instance.SuspensionReason> |
getSuspensionReasonsList()
Optional.
|
int |
getSuspensionReasonsValue(int index)
Optional.
|
List<Integer> |
getSuspensionReasonsValueList()
Optional.
|
Instance.Tier |
getTier()
Required.
|
int |
getTierValue()
Required.
|
Instance.TransitEncryptionMode |
getTransitEncryptionMode()
Optional.
|
int |
getTransitEncryptionModeValue()
Optional.
|
boolean |
hasCreateTime()
Output only.
|
int |
hashCode() |
boolean |
hasMaintenancePolicy()
Optional.
|
boolean |
hasMaintenanceSchedule()
Output only.
|
boolean |
hasPersistenceConfig()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static Instance.Builder |
newBuilder() |
static Instance.Builder |
newBuilder(Instance prototype) |
Instance.Builder |
newBuilderForType() |
protected Instance.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Instance |
parseDelimitedFrom(InputStream input) |
static Instance |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(byte[] data) |
static Instance |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(ByteBuffer data) |
static Instance |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(com.google.protobuf.ByteString data) |
static Instance |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Instance |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(InputStream input) |
static Instance |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Instance> |
parser() |
Instance.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int LOCATION_ID_FIELD_NUMBER
public static final int ALTERNATIVE_LOCATION_ID_FIELD_NUMBER
public static final int REDIS_VERSION_FIELD_NUMBER
public static final int RESERVED_IP_RANGE_FIELD_NUMBER
public static final int SECONDARY_IP_RANGE_FIELD_NUMBER
public static final int HOST_FIELD_NUMBER
public static final int PORT_FIELD_NUMBER
public static final int CURRENT_LOCATION_ID_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int STATUS_MESSAGE_FIELD_NUMBER
public static final int REDIS_CONFIGS_FIELD_NUMBER
public static final int TIER_FIELD_NUMBER
public static final int MEMORY_SIZE_GB_FIELD_NUMBER
public static final int AUTHORIZED_NETWORK_FIELD_NUMBER
public static final int PERSISTENCE_IAM_IDENTITY_FIELD_NUMBER
public static final int CONNECT_MODE_FIELD_NUMBER
public static final int AUTH_ENABLED_FIELD_NUMBER
public static final int SERVER_CA_CERTS_FIELD_NUMBER
public static final int TRANSIT_ENCRYPTION_MODE_FIELD_NUMBER
public static final int MAINTENANCE_POLICY_FIELD_NUMBER
public static final int MAINTENANCE_SCHEDULE_FIELD_NUMBER
public static final int REPLICA_COUNT_FIELD_NUMBER
public static final int NODES_FIELD_NUMBER
public static final int READ_ENDPOINT_FIELD_NUMBER
public static final int READ_ENDPOINT_PORT_FIELD_NUMBER
public static final int READ_REPLICAS_MODE_FIELD_NUMBER
public static final int CUSTOMER_MANAGED_KEY_FIELD_NUMBER
public static final int PERSISTENCE_CONFIG_FIELD_NUMBER
public static final int SUSPENSION_REASONS_FIELD_NUMBER
public static final int MAINTENANCE_VERSION_FIELD_NUMBER
public static final int AVAILABLE_MAINTENANCE_VERSIONS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Required. Unique name of the resource in this scope including project and
location using the form:
`projects/{project_id}/locations/{location_id}/instances/{instance_id}`
Note: Redis instances are managed and addressed at regional level so
location_id here refers to a GCP region; however, users may choose which
specific zone (or collection of zones for cross-zone instances) an instance
should be provisioned in. Refer to
[location_id][google.cloud.redis.v1.Instance.location_id] and
[alternative_location_id][google.cloud.redis.v1.Instance.alternative_location_id]
fields for more details.
string name = 1 [(.google.api.field_behavior) = REQUIRED];getName in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Required. Unique name of the resource in this scope including project and
location using the form:
`projects/{project_id}/locations/{location_id}/instances/{instance_id}`
Note: Redis instances are managed and addressed at regional level so
location_id here refers to a GCP region; however, users may choose which
specific zone (or collection of zones for cross-zone instances) an instance
should be provisioned in. Refer to
[location_id][google.cloud.redis.v1.Instance.location_id] and
[alternative_location_id][google.cloud.redis.v1.Instance.alternative_location_id]
fields for more details.
string name = 1 [(.google.api.field_behavior) = REQUIRED];getNameBytes in interface InstanceOrBuilderpublic String getDisplayName()
An arbitrary and optional user-provided name for the instance.
string display_name = 2;getDisplayName in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
An arbitrary and optional user-provided name for the instance.
string display_name = 2;getDisplayNameBytes in interface InstanceOrBuilderpublic int getLabelsCount()
InstanceOrBuilderResource labels to represent user provided metadata
map<string, string> labels = 3;getLabelsCount in interface InstanceOrBuilderpublic boolean containsLabels(String key)
Resource labels to represent user provided metadata
map<string, string> labels = 3;containsLabels in interface InstanceOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface InstanceOrBuilderpublic Map<String,String> getLabelsMap()
Resource labels to represent user provided metadata
map<string, string> labels = 3;getLabelsMap in interface InstanceOrBuilderpublic String getLabelsOrDefault(String key, String defaultValue)
Resource labels to represent user provided metadata
map<string, string> labels = 3;getLabelsOrDefault in interface InstanceOrBuilderpublic String getLabelsOrThrow(String key)
Resource labels to represent user provided metadata
map<string, string> labels = 3;getLabelsOrThrow in interface InstanceOrBuilderpublic String getLocationId()
Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.
string location_id = 4 [(.google.api.field_behavior) = OPTIONAL];getLocationId in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getLocationIdBytes()
Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.
string location_id = 4 [(.google.api.field_behavior) = OPTIONAL];getLocationIdBytes in interface InstanceOrBuilderpublic String getAlternativeLocationId()
Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service.
string alternative_location_id = 5 [(.google.api.field_behavior) = OPTIONAL];getAlternativeLocationId in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getAlternativeLocationIdBytes()
Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service.
string alternative_location_id = 5 [(.google.api.field_behavior) = OPTIONAL];getAlternativeLocationIdBytes in interface InstanceOrBuilderpublic String getRedisVersion()
Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility
string redis_version = 7 [(.google.api.field_behavior) = OPTIONAL];getRedisVersion in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getRedisVersionBytes()
Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility
string redis_version = 7 [(.google.api.field_behavior) = OPTIONAL];getRedisVersionBytes in interface InstanceOrBuilderpublic String getReservedIpRange()
Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.
string reserved_ip_range = 9 [(.google.api.field_behavior) = OPTIONAL];getReservedIpRange in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getReservedIpRangeBytes()
Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.
string reserved_ip_range = 9 [(.google.api.field_behavior) = OPTIONAL];getReservedIpRangeBytes in interface InstanceOrBuilderpublic String getSecondaryIpRange()
Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".
string secondary_ip_range = 30 [(.google.api.field_behavior) = OPTIONAL];getSecondaryIpRange in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getSecondaryIpRangeBytes()
Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".
string secondary_ip_range = 30 [(.google.api.field_behavior) = OPTIONAL];getSecondaryIpRangeBytes in interface InstanceOrBuilderpublic String getHost()
Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
string host = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];getHost in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getHostBytes()
Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
string host = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];getHostBytes in interface InstanceOrBuilderpublic int getPort()
Output only. The port number of the exposed Redis endpoint.
int32 port = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];getPort in interface InstanceOrBuilderpublic String getCurrentLocationId()
Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance.
string current_location_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];getCurrentLocationId in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getCurrentLocationIdBytes()
Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance.
string current_location_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];getCurrentLocationIdBytes in interface InstanceOrBuilderpublic boolean hasCreateTime()
Output only. The time the instance was created.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface InstanceOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. The time the instance was created.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface InstanceOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time the instance was created.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface InstanceOrBuilderpublic int getStateValue()
Output only. The current state of this instance.
.google.cloud.redis.v1.Instance.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface InstanceOrBuilderpublic Instance.State getState()
Output only. The current state of this instance.
.google.cloud.redis.v1.Instance.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface InstanceOrBuilderpublic String getStatusMessage()
Output only. Additional information about the current status of this instance, if available.
string status_message = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];getStatusMessage in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getStatusMessageBytes()
Output only. Additional information about the current status of this instance, if available.
string status_message = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];getStatusMessageBytes in interface InstanceOrBuilderpublic int getRedisConfigsCount()
InstanceOrBuilderOptional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL];
getRedisConfigsCount in interface InstanceOrBuilderpublic boolean containsRedisConfigs(String key)
Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL];
containsRedisConfigs in interface InstanceOrBuilder@Deprecated public Map<String,String> getRedisConfigs()
getRedisConfigsMap() instead.getRedisConfigs in interface InstanceOrBuilderpublic Map<String,String> getRedisConfigsMap()
Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL];
getRedisConfigsMap in interface InstanceOrBuilderpublic String getRedisConfigsOrDefault(String key, String defaultValue)
Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL];
getRedisConfigsOrDefault in interface InstanceOrBuilderpublic String getRedisConfigsOrThrow(String key)
Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
map<string, string> redis_configs = 16 [(.google.api.field_behavior) = OPTIONAL];
getRedisConfigsOrThrow in interface InstanceOrBuilderpublic int getTierValue()
Required. The service tier of the instance.
.google.cloud.redis.v1.Instance.Tier tier = 17 [(.google.api.field_behavior) = REQUIRED];
getTierValue in interface InstanceOrBuilderpublic Instance.Tier getTier()
Required. The service tier of the instance.
.google.cloud.redis.v1.Instance.Tier tier = 17 [(.google.api.field_behavior) = REQUIRED];
getTier in interface InstanceOrBuilderpublic int getMemorySizeGb()
Required. Redis memory size in GiB.
int32 memory_size_gb = 18 [(.google.api.field_behavior) = REQUIRED];getMemorySizeGb in interface InstanceOrBuilderpublic String getAuthorizedNetwork()
Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
string authorized_network = 20 [(.google.api.field_behavior) = OPTIONAL];getAuthorizedNetwork in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getAuthorizedNetworkBytes()
Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
string authorized_network = 20 [(.google.api.field_behavior) = OPTIONAL];getAuthorizedNetworkBytes in interface InstanceOrBuilderpublic String getPersistenceIamIdentity()
Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:<service_account_email>". The value may change over time for a given instance so should be checked before each import/export operation.
string persistence_iam_identity = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];getPersistenceIamIdentity in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getPersistenceIamIdentityBytes()
Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:<service_account_email>". The value may change over time for a given instance so should be checked before each import/export operation.
string persistence_iam_identity = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];getPersistenceIamIdentityBytes in interface InstanceOrBuilderpublic int getConnectModeValue()
Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
.google.cloud.redis.v1.Instance.ConnectMode connect_mode = 22 [(.google.api.field_behavior) = OPTIONAL];
getConnectModeValue in interface InstanceOrBuilderpublic Instance.ConnectMode getConnectMode()
Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
.google.cloud.redis.v1.Instance.ConnectMode connect_mode = 22 [(.google.api.field_behavior) = OPTIONAL];
getConnectMode in interface InstanceOrBuilderpublic boolean getAuthEnabled()
Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.
bool auth_enabled = 23 [(.google.api.field_behavior) = OPTIONAL];getAuthEnabled in interface InstanceOrBuilderpublic List<TlsCertificate> getServerCaCertsList()
Output only. List of server CA certificates for the instance.
repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
getServerCaCertsList in interface InstanceOrBuilderpublic List<? extends TlsCertificateOrBuilder> getServerCaCertsOrBuilderList()
Output only. List of server CA certificates for the instance.
repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
getServerCaCertsOrBuilderList in interface InstanceOrBuilderpublic int getServerCaCertsCount()
Output only. List of server CA certificates for the instance.
repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
getServerCaCertsCount in interface InstanceOrBuilderpublic TlsCertificate getServerCaCerts(int index)
Output only. List of server CA certificates for the instance.
repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
getServerCaCerts in interface InstanceOrBuilderpublic TlsCertificateOrBuilder getServerCaCertsOrBuilder(int index)
Output only. List of server CA certificates for the instance.
repeated .google.cloud.redis.v1.TlsCertificate server_ca_certs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
getServerCaCertsOrBuilder in interface InstanceOrBuilderpublic int getTransitEncryptionModeValue()
Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
.google.cloud.redis.v1.Instance.TransitEncryptionMode transit_encryption_mode = 26 [(.google.api.field_behavior) = OPTIONAL];
getTransitEncryptionModeValue in interface InstanceOrBuilderpublic Instance.TransitEncryptionMode getTransitEncryptionMode()
Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
.google.cloud.redis.v1.Instance.TransitEncryptionMode transit_encryption_mode = 26 [(.google.api.field_behavior) = OPTIONAL];
getTransitEncryptionMode in interface InstanceOrBuilderpublic boolean hasMaintenancePolicy()
Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
.google.cloud.redis.v1.MaintenancePolicy maintenance_policy = 27 [(.google.api.field_behavior) = OPTIONAL];
hasMaintenancePolicy in interface InstanceOrBuilderpublic MaintenancePolicy getMaintenancePolicy()
Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
.google.cloud.redis.v1.MaintenancePolicy maintenance_policy = 27 [(.google.api.field_behavior) = OPTIONAL];
getMaintenancePolicy in interface InstanceOrBuilderpublic MaintenancePolicyOrBuilder getMaintenancePolicyOrBuilder()
Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
.google.cloud.redis.v1.MaintenancePolicy maintenance_policy = 27 [(.google.api.field_behavior) = OPTIONAL];
getMaintenancePolicyOrBuilder in interface InstanceOrBuilderpublic boolean hasMaintenanceSchedule()
Output only. Date and time of upcoming maintenance events which have been scheduled.
.google.cloud.redis.v1.MaintenanceSchedule maintenance_schedule = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasMaintenanceSchedule in interface InstanceOrBuilderpublic MaintenanceSchedule getMaintenanceSchedule()
Output only. Date and time of upcoming maintenance events which have been scheduled.
.google.cloud.redis.v1.MaintenanceSchedule maintenance_schedule = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
getMaintenanceSchedule in interface InstanceOrBuilderpublic MaintenanceScheduleOrBuilder getMaintenanceScheduleOrBuilder()
Output only. Date and time of upcoming maintenance events which have been scheduled.
.google.cloud.redis.v1.MaintenanceSchedule maintenance_schedule = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
getMaintenanceScheduleOrBuilder in interface InstanceOrBuilderpublic int getReplicaCount()
Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.
int32 replica_count = 31 [(.google.api.field_behavior) = OPTIONAL];getReplicaCount in interface InstanceOrBuilderpublic List<NodeInfo> getNodesList()
Output only. Info per node.
repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
getNodesList in interface InstanceOrBuilderpublic List<? extends NodeInfoOrBuilder> getNodesOrBuilderList()
Output only. Info per node.
repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
getNodesOrBuilderList in interface InstanceOrBuilderpublic int getNodesCount()
Output only. Info per node.
repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
getNodesCount in interface InstanceOrBuilderpublic NodeInfo getNodes(int index)
Output only. Info per node.
repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
getNodes in interface InstanceOrBuilderpublic NodeInfoOrBuilder getNodesOrBuilder(int index)
Output only. Info per node.
repeated .google.cloud.redis.v1.NodeInfo nodes = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
getNodesOrBuilder in interface InstanceOrBuilderpublic String getReadEndpoint()
Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.
string read_endpoint = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];getReadEndpoint in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getReadEndpointBytes()
Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.
string read_endpoint = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];getReadEndpointBytes in interface InstanceOrBuilderpublic int getReadEndpointPort()
Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.
int32 read_endpoint_port = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];getReadEndpointPort in interface InstanceOrBuilderpublic int getReadReplicasModeValue()
Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
.google.cloud.redis.v1.Instance.ReadReplicasMode read_replicas_mode = 35 [(.google.api.field_behavior) = OPTIONAL];
getReadReplicasModeValue in interface InstanceOrBuilderpublic Instance.ReadReplicasMode getReadReplicasMode()
Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
.google.cloud.redis.v1.Instance.ReadReplicasMode read_replicas_mode = 35 [(.google.api.field_behavior) = OPTIONAL];
getReadReplicasMode in interface InstanceOrBuilderpublic String getCustomerManagedKey()
Optional. The KMS key reference that the customer provides when trying to create the instance.
string customer_managed_key = 36 [(.google.api.field_behavior) = OPTIONAL];getCustomerManagedKey in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getCustomerManagedKeyBytes()
Optional. The KMS key reference that the customer provides when trying to create the instance.
string customer_managed_key = 36 [(.google.api.field_behavior) = OPTIONAL];getCustomerManagedKeyBytes in interface InstanceOrBuilderpublic boolean hasPersistenceConfig()
Optional. Persistence configuration parameters
.google.cloud.redis.v1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL];
hasPersistenceConfig in interface InstanceOrBuilderpublic PersistenceConfig getPersistenceConfig()
Optional. Persistence configuration parameters
.google.cloud.redis.v1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL];
getPersistenceConfig in interface InstanceOrBuilderpublic PersistenceConfigOrBuilder getPersistenceConfigOrBuilder()
Optional. Persistence configuration parameters
.google.cloud.redis.v1.PersistenceConfig persistence_config = 37 [(.google.api.field_behavior) = OPTIONAL];
getPersistenceConfigOrBuilder in interface InstanceOrBuilderpublic List<Instance.SuspensionReason> getSuspensionReasonsList()
Optional. reasons that causes instance in "SUSPENDED" state.
repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];
getSuspensionReasonsList in interface InstanceOrBuilderpublic int getSuspensionReasonsCount()
Optional. reasons that causes instance in "SUSPENDED" state.
repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];
getSuspensionReasonsCount in interface InstanceOrBuilderpublic Instance.SuspensionReason getSuspensionReasons(int index)
Optional. reasons that causes instance in "SUSPENDED" state.
repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];
getSuspensionReasons in interface InstanceOrBuilderindex - The index of the element to return.public List<Integer> getSuspensionReasonsValueList()
Optional. reasons that causes instance in "SUSPENDED" state.
repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];
getSuspensionReasonsValueList in interface InstanceOrBuilderpublic int getSuspensionReasonsValue(int index)
Optional. reasons that causes instance in "SUSPENDED" state.
repeated .google.cloud.redis.v1.Instance.SuspensionReason suspension_reasons = 38 [(.google.api.field_behavior) = OPTIONAL];
getSuspensionReasonsValue in interface InstanceOrBuilderindex - The index of the value to return.public String getMaintenanceVersion()
Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".
string maintenance_version = 39 [(.google.api.field_behavior) = OPTIONAL];getMaintenanceVersion in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getMaintenanceVersionBytes()
Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".
string maintenance_version = 39 [(.google.api.field_behavior) = OPTIONAL];getMaintenanceVersionBytes in interface InstanceOrBuilderpublic com.google.protobuf.ProtocolStringList getAvailableMaintenanceVersionsList()
Optional. The available maintenance versions that an instance could update to.
repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];
getAvailableMaintenanceVersionsList in interface InstanceOrBuilderpublic int getAvailableMaintenanceVersionsCount()
Optional. The available maintenance versions that an instance could update to.
repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];
getAvailableMaintenanceVersionsCount in interface InstanceOrBuilderpublic String getAvailableMaintenanceVersions(int index)
Optional. The available maintenance versions that an instance could update to.
repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];
getAvailableMaintenanceVersions in interface InstanceOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getAvailableMaintenanceVersionsBytes(int index)
Optional. The available maintenance versions that an instance could update to.
repeated string available_maintenance_versions = 40 [(.google.api.field_behavior) = OPTIONAL];
getAvailableMaintenanceVersionsBytes in interface InstanceOrBuilderindex - The index of the value to return.public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Instance parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(InputStream input) throws IOException
IOExceptionpublic static Instance parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Instance parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Instance parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Instance parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Instance parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Instance.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Instance.Builder newBuilder()
public static Instance.Builder newBuilder(Instance prototype)
public Instance.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Instance.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Instance getDefaultInstance()
public static com.google.protobuf.Parser<Instance> parser()
public com.google.protobuf.Parser<Instance> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Instance getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.