Package com.google.cloud.alloydb.v1beta
Interface InstanceOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Instance,Instance.Builder
@Generated
public interface InstanceOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleanAnnotations to allow client tools to store small amount of arbitrary data.booleanDatabase flags.booleancontainsLabels(String key) Labels as key value pairsOptional.intOptional.Deprecated.intAnnotations to allow client tools to store small amount of arbitrary data.Annotations to allow client tools to store small amount of arbitrary data.getAnnotationsOrDefault(String key, String defaultValue) Annotations to allow client tools to store small amount of arbitrary data.Annotations to allow client tools to store small amount of arbitrary data.Availability type of an Instance.intAvailability type of an Instance.Optional.Optional.Optional.Optional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Deprecated.intDatabase flags.Database flags.getDatabaseFlagsOrDefault(String key, String defaultValue) Database flags.Database flags.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.User-settable and human-readable display name for the Instance.com.google.protobuf.ByteStringUser-settable and human-readable display name for the Instance.getEtag()For Resource freshness validation (https://google.aip.dev/154)com.google.protobuf.ByteStringFor Resource freshness validation (https://google.aip.dev/154)Output only.Output only.The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances.com.google.protobuf.ByteStringThe Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances.Deprecated.google.cloud.alloydb.v1beta.Instance.gemini_config is deprecated.Deprecated.Required.intRequired.Output only.com.google.protobuf.ByteStringOutput only.Deprecated.intLabels as key value pairsLabels as key value pairsgetLabelsOrDefault(String key, String defaultValue) Labels as key value pairsgetLabelsOrThrow(String key) Labels as key value pairsConfigurations for the machines that host the underlying database engine.Configurations for the machines that host the underlying database engine.getName()Output only.com.google.protobuf.ByteStringOutput only.Optional.Optional.getNodes(int index) Output only.intOutput only.Output only.getNodesOrBuilder(int index) Output only.List<? extends Instance.NodeOrBuilder>Output only.Configuration for observability.Configuration for observability.getOutboundPublicIpAddresses(int index) Output only.com.google.protobuf.ByteStringgetOutboundPublicIpAddressesBytes(int index) Output only.intOutput only.Output only.Optional.Optional.Output only.com.google.protobuf.ByteStringOutput only.Configuration for query insights.Configuration for query insights.Read pool instance configuration.Read pool instance configuration.booleanOutput only.booleanOutput only.getState()Output only.intOutput only.getUid()Output only.com.google.protobuf.ByteStringOutput only.Update policy that will be applied during instance update.Update policy that will be applied during instance update.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Output only.Output only.booleanOptional.booleanOptional.booleanOutput only.booleanOutput only.booleanOutput only.booleanDeprecated.google.cloud.alloydb.v1beta.Instance.gemini_config is deprecated.booleanConfigurations for the machines that host the underlying database engine.booleanOptional.booleanConfiguration for observability.booleanOptional.booleanConfiguration for query insights.booleanRead pool instance configuration.booleanUpdate policy that will be applied during instance update.booleanOutput only.booleanOutput only.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The bytes for name.
-
getDisplayName
String getDisplayName()User-settable and human-readable display name for the Instance.
string display_name = 2;- Returns:
- The displayName.
-
getDisplayNameBytes
com.google.protobuf.ByteString getDisplayNameBytes()User-settable and human-readable display name for the Instance.
string display_name = 2;- Returns:
- The bytes for displayName.
-
getUid
String getUid()Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The uid.
-
getUidBytes
com.google.protobuf.ByteString getUidBytes()Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The bytes for uid.
-
hasCreateTime
boolean hasCreateTime()Output only. Create time stamp
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()Output only. Create time stamp
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. Create time stamp
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasUpdateTime
boolean hasUpdateTime()Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
com.google.protobuf.Timestamp getUpdateTime()Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasDeleteTime
boolean hasDeleteTime()Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the deleteTime field is set.
-
getDeleteTime
com.google.protobuf.Timestamp getDeleteTime()Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The deleteTime.
-
getDeleteTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getLabelsCount
int getLabelsCount()Labels as key value pairs
map<string, string> labels = 7; -
containsLabels
Labels as key value pairs
map<string, string> labels = 7; -
getLabels
Deprecated.UsegetLabelsMap()instead. -
getLabelsMap
Labels as key value pairs
map<string, string> labels = 7; -
getLabelsOrDefault
Labels as key value pairs
map<string, string> labels = 7; -
getLabelsOrThrow
Labels as key value pairs
map<string, string> labels = 7; -
getStateValue
int getStateValue()Output only. The current serving state of the instance.
.google.cloud.alloydb.v1beta.Instance.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The enum numeric value on the wire for state.
-
getState
Instance.State getState()Output only. The current serving state of the instance.
.google.cloud.alloydb.v1beta.Instance.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The state.
-
getInstanceTypeValue
int getInstanceTypeValue()Required. The type of the instance. Specified at creation time.
.google.cloud.alloydb.v1beta.Instance.InstanceType instance_type = 9 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The enum numeric value on the wire for instanceType.
-
getInstanceType
Instance.InstanceType getInstanceType()Required. The type of the instance. Specified at creation time.
.google.cloud.alloydb.v1beta.Instance.InstanceType instance_type = 9 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The instanceType.
-
hasMachineConfig
boolean hasMachineConfig()Configurations for the machines that host the underlying database engine.
.google.cloud.alloydb.v1beta.Instance.MachineConfig machine_config = 10;- Returns:
- Whether the machineConfig field is set.
-
getMachineConfig
Instance.MachineConfig getMachineConfig()Configurations for the machines that host the underlying database engine.
.google.cloud.alloydb.v1beta.Instance.MachineConfig machine_config = 10;- Returns:
- The machineConfig.
-
getMachineConfigOrBuilder
Instance.MachineConfigOrBuilder getMachineConfigOrBuilder()Configurations for the machines that host the underlying database engine.
.google.cloud.alloydb.v1beta.Instance.MachineConfig machine_config = 10; -
getAvailabilityTypeValue
int getAvailabilityTypeValue()Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
.google.cloud.alloydb.v1beta.Instance.AvailabilityType availability_type = 11;- Returns:
- The enum numeric value on the wire for availabilityType.
-
getAvailabilityType
Instance.AvailabilityType getAvailabilityType()Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
.google.cloud.alloydb.v1beta.Instance.AvailabilityType availability_type = 11;- Returns:
- The availabilityType.
-
getGceZone
String getGceZone()The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
string gce_zone = 12;- Returns:
- The gceZone.
-
getGceZoneBytes
com.google.protobuf.ByteString getGceZoneBytes()The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
string gce_zone = 12;- Returns:
- The bytes for gceZone.
-
getDatabaseFlagsCount
int getDatabaseFlagsCount()Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
map<string, string> database_flags = 13; -
containsDatabaseFlags
Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
map<string, string> database_flags = 13; -
getDatabaseFlags
Deprecated.UsegetDatabaseFlagsMap()instead. -
getDatabaseFlagsMap
Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
map<string, string> database_flags = 13; -
getDatabaseFlagsOrDefault
Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
map<string, string> database_flags = 13; -
getDatabaseFlagsOrThrow
Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
map<string, string> database_flags = 13; -
hasWritableNode
boolean hasWritableNode()Output only. This is set for the read-write VM of the PRIMARY instance only.
.google.cloud.alloydb.v1beta.Instance.Node writable_node = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the writableNode field is set.
-
getWritableNode
Instance.Node getWritableNode()Output only. This is set for the read-write VM of the PRIMARY instance only.
.google.cloud.alloydb.v1beta.Instance.Node writable_node = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The writableNode.
-
getWritableNodeOrBuilder
Instance.NodeOrBuilder getWritableNodeOrBuilder()Output only. This is set for the read-write VM of the PRIMARY instance only.
.google.cloud.alloydb.v1beta.Instance.Node writable_node = 19 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getNodesList
List<Instance.Node> getNodesList()Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
repeated .google.cloud.alloydb.v1beta.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getNodes
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
repeated .google.cloud.alloydb.v1beta.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getNodesCount
int getNodesCount()Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
repeated .google.cloud.alloydb.v1beta.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getNodesOrBuilderList
List<? extends Instance.NodeOrBuilder> getNodesOrBuilderList()Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
repeated .google.cloud.alloydb.v1beta.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getNodesOrBuilder
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
repeated .google.cloud.alloydb.v1beta.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasQueryInsightsConfig
boolean hasQueryInsightsConfig()Configuration for query insights.
.google.cloud.alloydb.v1beta.Instance.QueryInsightsInstanceConfig query_insights_config = 21;- Returns:
- Whether the queryInsightsConfig field is set.
-
getQueryInsightsConfig
Instance.QueryInsightsInstanceConfig getQueryInsightsConfig()Configuration for query insights.
.google.cloud.alloydb.v1beta.Instance.QueryInsightsInstanceConfig query_insights_config = 21;- Returns:
- The queryInsightsConfig.
-
getQueryInsightsConfigOrBuilder
Instance.QueryInsightsInstanceConfigOrBuilder getQueryInsightsConfigOrBuilder()Configuration for query insights.
.google.cloud.alloydb.v1beta.Instance.QueryInsightsInstanceConfig query_insights_config = 21; -
hasObservabilityConfig
boolean hasObservabilityConfig()Configuration for observability.
.google.cloud.alloydb.v1beta.Instance.ObservabilityInstanceConfig observability_config = 26;- Returns:
- Whether the observabilityConfig field is set.
-
getObservabilityConfig
Instance.ObservabilityInstanceConfig getObservabilityConfig()Configuration for observability.
.google.cloud.alloydb.v1beta.Instance.ObservabilityInstanceConfig observability_config = 26;- Returns:
- The observabilityConfig.
-
getObservabilityConfigOrBuilder
Instance.ObservabilityInstanceConfigOrBuilder getObservabilityConfigOrBuilder()Configuration for observability.
.google.cloud.alloydb.v1beta.Instance.ObservabilityInstanceConfig observability_config = 26; -
hasReadPoolConfig
boolean hasReadPoolConfig()Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
.google.cloud.alloydb.v1beta.Instance.ReadPoolConfig read_pool_config = 14;- Returns:
- Whether the readPoolConfig field is set.
-
getReadPoolConfig
Instance.ReadPoolConfig getReadPoolConfig()Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
.google.cloud.alloydb.v1beta.Instance.ReadPoolConfig read_pool_config = 14;- Returns:
- The readPoolConfig.
-
getReadPoolConfigOrBuilder
Instance.ReadPoolConfigOrBuilder getReadPoolConfigOrBuilder()Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
.google.cloud.alloydb.v1beta.Instance.ReadPoolConfig read_pool_config = 14; -
getIpAddress
String getIpAddress()Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.
string ip_address = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The ipAddress.
-
getIpAddressBytes
com.google.protobuf.ByteString getIpAddressBytes()Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.
string ip_address = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The bytes for ipAddress.
-
getPublicIpAddress
String getPublicIpAddress()Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
string public_ip_address = 27 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }- Returns:
- The publicIpAddress.
-
getPublicIpAddressBytes
com.google.protobuf.ByteString getPublicIpAddressBytes()Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
string public_ip_address = 27 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }- Returns:
- The bytes for publicIpAddress.
-
getReconciling
boolean getReconciling()Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
bool reconciling = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The reconciling.
-
getEtag
String getEtag()For Resource freshness validation (https://google.aip.dev/154)
string etag = 17;- Returns:
- The etag.
-
getEtagBytes
com.google.protobuf.ByteString getEtagBytes()For Resource freshness validation (https://google.aip.dev/154)
string etag = 17;- Returns:
- The bytes for etag.
-
getAnnotationsCount
int getAnnotationsCount()Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
map<string, string> annotations = 18; -
containsAnnotations
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
map<string, string> annotations = 18; -
getAnnotations
Deprecated.UsegetAnnotationsMap()instead. -
getAnnotationsMap
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
map<string, string> annotations = 18; -
getAnnotationsOrDefault
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
map<string, string> annotations = 18; -
getAnnotationsOrThrow
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
map<string, string> annotations = 18; -
hasUpdatePolicy
boolean hasUpdatePolicy()Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
.google.cloud.alloydb.v1beta.Instance.UpdatePolicy update_policy = 22;- Returns:
- Whether the updatePolicy field is set.
-
getUpdatePolicy
Instance.UpdatePolicy getUpdatePolicy()Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
.google.cloud.alloydb.v1beta.Instance.UpdatePolicy update_policy = 22;- Returns:
- The updatePolicy.
-
getUpdatePolicyOrBuilder
Instance.UpdatePolicyOrBuilder getUpdatePolicyOrBuilder()Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
.google.cloud.alloydb.v1beta.Instance.UpdatePolicy update_policy = 22; -
hasClientConnectionConfig
boolean hasClientConnectionConfig()Optional. Client connection specific configurations
.google.cloud.alloydb.v1beta.Instance.ClientConnectionConfig client_connection_config = 23 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the clientConnectionConfig field is set.
-
getClientConnectionConfig
Instance.ClientConnectionConfig getClientConnectionConfig()Optional. Client connection specific configurations
.google.cloud.alloydb.v1beta.Instance.ClientConnectionConfig client_connection_config = 23 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The clientConnectionConfig.
-
getClientConnectionConfigOrBuilder
Instance.ClientConnectionConfigOrBuilder getClientConnectionConfigOrBuilder()Optional. Client connection specific configurations
.google.cloud.alloydb.v1beta.Instance.ClientConnectionConfig client_connection_config = 23 [(.google.api.field_behavior) = OPTIONAL]; -
getSatisfiesPzs
boolean getSatisfiesPzs()Output only. Reserved for future use.
bool satisfies_pzs = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The satisfiesPzs.
-
hasPscInstanceConfig
boolean hasPscInstanceConfig()Optional. The configuration for Private Service Connect (PSC) for the instance.
.google.cloud.alloydb.v1beta.Instance.PscInstanceConfig psc_instance_config = 28 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the pscInstanceConfig field is set.
-
getPscInstanceConfig
Instance.PscInstanceConfig getPscInstanceConfig()Optional. The configuration for Private Service Connect (PSC) for the instance.
.google.cloud.alloydb.v1beta.Instance.PscInstanceConfig psc_instance_config = 28 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The pscInstanceConfig.
-
getPscInstanceConfigOrBuilder
Instance.PscInstanceConfigOrBuilder getPscInstanceConfigOrBuilder()Optional. The configuration for Private Service Connect (PSC) for the instance.
.google.cloud.alloydb.v1beta.Instance.PscInstanceConfig psc_instance_config = 28 [(.google.api.field_behavior) = OPTIONAL]; -
hasNetworkConfig
boolean hasNetworkConfig()Optional. Instance-level network configuration.
.google.cloud.alloydb.v1beta.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the networkConfig field is set.
-
getNetworkConfig
Instance.InstanceNetworkConfig getNetworkConfig()Optional. Instance-level network configuration.
.google.cloud.alloydb.v1beta.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The networkConfig.
-
getNetworkConfigOrBuilder
Instance.InstanceNetworkConfigOrBuilder getNetworkConfigOrBuilder()Optional. Instance-level network configuration.
.google.cloud.alloydb.v1beta.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL]; -
hasGeminiConfig
Deprecated.google.cloud.alloydb.v1beta.Instance.gemini_config is deprecated. See google/cloud/alloydb/v1beta/resources.proto;l=1325Optional. Deprecated and unused. This field will be removed in the near future.
.google.cloud.alloydb.v1beta.GeminiInstanceConfig gemini_config = 33 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the geminiConfig field is set.
-
getGeminiConfig
Deprecated.google.cloud.alloydb.v1beta.Instance.gemini_config is deprecated. See google/cloud/alloydb/v1beta/resources.proto;l=1325Optional. Deprecated and unused. This field will be removed in the near future.
.google.cloud.alloydb.v1beta.GeminiInstanceConfig gemini_config = 33 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];- Returns:
- The geminiConfig.
-
getGeminiConfigOrBuilder
Deprecated.Optional. Deprecated and unused. This field will be removed in the near future.
.google.cloud.alloydb.v1beta.GeminiInstanceConfig gemini_config = 33 [deprecated = true, (.google.api.field_behavior) = OPTIONAL]; -
getOutboundPublicIpAddressesList
Output only. All outbound public IP addresses configured for the instance.
repeated string outbound_public_ip_addresses = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }- Returns:
- A list containing the outboundPublicIpAddresses.
-
getOutboundPublicIpAddressesCount
int getOutboundPublicIpAddressesCount()Output only. All outbound public IP addresses configured for the instance.
repeated string outbound_public_ip_addresses = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }- Returns:
- The count of outboundPublicIpAddresses.
-
getOutboundPublicIpAddresses
Output only. All outbound public IP addresses configured for the instance.
repeated string outbound_public_ip_addresses = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }- Parameters:
index- The index of the element to return.- Returns:
- The outboundPublicIpAddresses at the given index.
-
getOutboundPublicIpAddressesBytes
com.google.protobuf.ByteString getOutboundPublicIpAddressesBytes(int index) Output only. All outbound public IP addresses configured for the instance.
repeated string outbound_public_ip_addresses = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the outboundPublicIpAddresses at the given index.
-
getActivationPolicyValue
int getActivationPolicyValue()Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details.
.google.cloud.alloydb.v1beta.Instance.ActivationPolicy activation_policy = 35 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The enum numeric value on the wire for activationPolicy.
-
getActivationPolicy
Instance.ActivationPolicy getActivationPolicy()Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details.
.google.cloud.alloydb.v1beta.Instance.ActivationPolicy activation_policy = 35 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The activationPolicy.
-
hasConnectionPoolConfig
boolean hasConnectionPoolConfig()Optional. The configuration for Managed Connection Pool (MCP).
.google.cloud.alloydb.v1beta.Instance.ConnectionPoolConfig connection_pool_config = 37 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the connectionPoolConfig field is set.
-
getConnectionPoolConfig
Instance.ConnectionPoolConfig getConnectionPoolConfig()Optional. The configuration for Managed Connection Pool (MCP).
.google.cloud.alloydb.v1beta.Instance.ConnectionPoolConfig connection_pool_config = 37 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The connectionPoolConfig.
-
getConnectionPoolConfigOrBuilder
Instance.ConnectionPoolConfigOrBuilder getConnectionPoolConfigOrBuilder()Optional. The configuration for Managed Connection Pool (MCP).
.google.cloud.alloydb.v1beta.Instance.ConnectionPoolConfig connection_pool_config = 37 [(.google.api.field_behavior) = OPTIONAL]; -
hasGcaConfig
boolean hasGcaConfig()Output only. Configuration parameters related to Gemini Cloud Assist.
.google.cloud.alloydb.v1beta.GCAInstanceConfig gca_config = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the gcaConfig field is set.
-
getGcaConfig
GCAInstanceConfig getGcaConfig()Output only. Configuration parameters related to Gemini Cloud Assist.
.google.cloud.alloydb.v1beta.GCAInstanceConfig gca_config = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The gcaConfig.
-
getGcaConfigOrBuilder
GCAInstanceConfigOrBuilder getGcaConfigOrBuilder()Output only. Configuration parameters related to Gemini Cloud Assist.
.google.cloud.alloydb.v1beta.GCAInstanceConfig gca_config = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
-