Instance (proto-google-cloud-alloydb-v1 0.52.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.alloydb.v1.Instance

All Implemented Interfaces:

InstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class Instance
extends com.google.protobuf.GeneratedMessageV3
implements InstanceOrBuilder
```
```
 An Instance is a computing unit that an end customer can connect to.
 It's the main unit of computing resources in AlloyDB.
 
```
Protobuf type google.cloud.alloydb.v1.Instance
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Instance.AvailabilityType` The Availability type of an instance.
`static class`	`Instance.Builder` An Instance is a computing unit that an end customer can connect to.
`static class`	`Instance.ClientConnectionConfig` Client connection configuration Protobuf type `google.cloud.alloydb.v1.Instance.ClientConnectionConfig`
`static interface`	`Instance.ClientConnectionConfigOrBuilder`
`static class`	`Instance.InstanceNetworkConfig` Metadata related to instance-level network configuration.
`static interface`	`Instance.InstanceNetworkConfigOrBuilder`
`static class`	`Instance.InstanceType` Type of an Instance Protobuf enum `google.cloud.alloydb.v1.Instance.InstanceType`
`static class`	`Instance.MachineConfig` MachineConfig describes the configuration of a machine.
`static interface`	`Instance.MachineConfigOrBuilder`
`static class`	`Instance.Node` Details of a single node in the instance.
`static interface`	`Instance.NodeOrBuilder`
`static class`	`Instance.ObservabilityInstanceConfig` Observability Instance specific configuration.
`static interface`	`Instance.ObservabilityInstanceConfigOrBuilder`
`static class`	`Instance.PscAutoConnectionConfig` Configuration for setting up PSC service automation.
`static interface`	`Instance.PscAutoConnectionConfigOrBuilder`
`static class`	`Instance.PscInstanceConfig` PscInstanceConfig contains PSC related configuration at an instance level.
`static interface`	`Instance.PscInstanceConfigOrBuilder`
`static class`	`Instance.PscInterfaceConfig` Configuration for setting up a PSC interface to enable outbound connectivity.
`static interface`	`Instance.PscInterfaceConfigOrBuilder`
`static class`	`Instance.QueryInsightsInstanceConfig` QueryInsights Instance specific configuration.
`static interface`	`Instance.QueryInsightsInstanceConfigOrBuilder`
`static class`	`Instance.ReadPoolConfig` Configuration for a read pool instance.
`static interface`	`Instance.ReadPoolConfigOrBuilder`
`static class`	`Instance.State` Instance State Protobuf enum `google.cloud.alloydb.v1.Instance.State`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
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

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ANNOTATIONS_FIELD_NUMBER`
`static int`	`AVAILABILITY_TYPE_FIELD_NUMBER`
`static int`	`CLIENT_CONNECTION_CONFIG_FIELD_NUMBER`
`static int`	`CREATE_TIME_FIELD_NUMBER`
`static int`	`DATABASE_FLAGS_FIELD_NUMBER`
`static int`	`DELETE_TIME_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`ETAG_FIELD_NUMBER`
`static int`	`GCE_ZONE_FIELD_NUMBER`
`static int`	`INSTANCE_TYPE_FIELD_NUMBER`
`static int`	`IP_ADDRESS_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`MACHINE_CONFIG_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`NETWORK_CONFIG_FIELD_NUMBER`
`static int`	`NODES_FIELD_NUMBER`
`static int`	`OBSERVABILITY_CONFIG_FIELD_NUMBER`
`static int`	`OUTBOUND_PUBLIC_IP_ADDRESSES_FIELD_NUMBER`
`static int`	`PSC_INSTANCE_CONFIG_FIELD_NUMBER`
`static int`	`PUBLIC_IP_ADDRESS_FIELD_NUMBER`
`static int`	`QUERY_INSIGHTS_CONFIG_FIELD_NUMBER`
`static int`	`READ_POOL_CONFIG_FIELD_NUMBER`
`static int`	`RECONCILING_FIELD_NUMBER`
`static int`	`SATISFIES_PZS_FIELD_NUMBER`
`static int`	`STATE_FIELD_NUMBER`
`static int`	`UID_FIELD_NUMBER`
`static int`	`UPDATE_TIME_FIELD_NUMBER`
`static int`	`WRITABLE_NODE_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsAnnotations(String key)` Annotations to allow client tools to store small amount of arbitrary data.
`boolean`	`containsDatabaseFlags(String key)` Database flags.
`boolean`	`containsLabels(String key)` Labels as key value pairs `map<string, string> labels = 7;`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAnnotations()` Deprecated.
`int`	`getAnnotationsCount()` Annotations to allow client tools to store small amount of arbitrary data.
`Map<String,String>`	`getAnnotationsMap()` Annotations to allow client tools to store small amount of arbitrary data.
`String`	`getAnnotationsOrDefault(String key, String defaultValue)` Annotations to allow client tools to store small amount of arbitrary data.
`String`	`getAnnotationsOrThrow(String key)` Annotations to allow client tools to store small amount of arbitrary data.
`Instance.AvailabilityType`	`getAvailabilityType()` Availability type of an Instance.
`int`	`getAvailabilityTypeValue()` Availability type of an Instance.
`Instance.ClientConnectionConfig`	`getClientConnectionConfig()` Optional.
`Instance.ClientConnectionConfigOrBuilder`	`getClientConnectionConfigOrBuilder()` Optional.
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`Map<String,String>`	`getDatabaseFlags()` Deprecated.
`int`	`getDatabaseFlagsCount()` Database flags.
`Map<String,String>`	`getDatabaseFlagsMap()` Database flags.
`String`	`getDatabaseFlagsOrDefault(String key, String defaultValue)` Database flags.
`String`	`getDatabaseFlagsOrThrow(String key)` Database flags.
`static Instance`	`getDefaultInstance()`
`Instance`	`getDefaultInstanceForType()`
`com.google.protobuf.Timestamp`	`getDeleteTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getDeleteTimeOrBuilder()` Output only.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getDisplayName()` User-settable and human-readable display name for the Instance.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` User-settable and human-readable display name for the Instance.
`String`	`getEtag()` For Resource freshness validation (https://google.aip.dev/154) `string etag = 17;`
`com.google.protobuf.ByteString`	`getEtagBytes()` For Resource freshness validation (https://google.aip.dev/154) `string etag = 17;`
`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.
`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.
`Instance.InstanceType`	`getInstanceType()` Required.
`int`	`getInstanceTypeValue()` Required.
`String`	`getIpAddress()` Output only.
`com.google.protobuf.ByteString`	`getIpAddressBytes()` Output only.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` Labels as key value pairs `map<string, string> labels = 7;`
`Map<String,String>`	`getLabelsMap()` Labels as key value pairs `map<string, string> labels = 7;`
`String`	`getLabelsOrDefault(String key, String defaultValue)` Labels as key value pairs `map<string, string> labels = 7;`
`String`	`getLabelsOrThrow(String key)` Labels as key value pairs `map<string, string> labels = 7;`
`Instance.MachineConfig`	`getMachineConfig()` Configurations for the machines that host the underlying database engine.
`Instance.MachineConfigOrBuilder`	`getMachineConfigOrBuilder()` Configurations for the machines that host the underlying database engine.
`String`	`getName()` Output only.
`com.google.protobuf.ByteString`	`getNameBytes()` Output only.
`Instance.InstanceNetworkConfig`	`getNetworkConfig()` Optional.
`Instance.InstanceNetworkConfigOrBuilder`	`getNetworkConfigOrBuilder()` Optional.
`Instance.Node`	`getNodes(int index)` Output only.
`int`	`getNodesCount()` Output only.
`List<Instance.Node>`	`getNodesList()` Output only.
`Instance.NodeOrBuilder`	`getNodesOrBuilder(int index)` Output only.
`List<? extends Instance.NodeOrBuilder>`	`getNodesOrBuilderList()` Output only.
`Instance.ObservabilityInstanceConfig`	`getObservabilityConfig()` Configuration for observability.
`Instance.ObservabilityInstanceConfigOrBuilder`	`getObservabilityConfigOrBuilder()` Configuration for observability.
`String`	`getOutboundPublicIpAddresses(int index)` Output only.
`com.google.protobuf.ByteString`	`getOutboundPublicIpAddressesBytes(int index)` Output only.
`int`	`getOutboundPublicIpAddressesCount()` Output only.
`com.google.protobuf.ProtocolStringList`	`getOutboundPublicIpAddressesList()` Output only.
`com.google.protobuf.Parser<Instance>`	`getParserForType()`
`Instance.PscInstanceConfig`	`getPscInstanceConfig()` Optional.
`Instance.PscInstanceConfigOrBuilder`	`getPscInstanceConfigOrBuilder()` Optional.
`String`	`getPublicIpAddress()` Output only.
`com.google.protobuf.ByteString`	`getPublicIpAddressBytes()` Output only.
`Instance.QueryInsightsInstanceConfig`	`getQueryInsightsConfig()` Configuration for query insights.
`Instance.QueryInsightsInstanceConfigOrBuilder`	`getQueryInsightsConfigOrBuilder()` Configuration for query insights.
`Instance.ReadPoolConfig`	`getReadPoolConfig()` Read pool instance configuration.
`Instance.ReadPoolConfigOrBuilder`	`getReadPoolConfigOrBuilder()` Read pool instance configuration.
`boolean`	`getReconciling()` Output only.
`boolean`	`getSatisfiesPzs()` Output only.
`int`	`getSerializedSize()`
`Instance.State`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`String`	`getUid()` Output only.
`com.google.protobuf.ByteString`	`getUidBytes()` Output only.
`com.google.protobuf.Timestamp`	`getUpdateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`Instance.Node`	`getWritableNode()` Output only.
`Instance.NodeOrBuilder`	`getWritableNodeOrBuilder()` Output only.
`boolean`	`hasClientConnectionConfig()` Optional.
`boolean`	`hasCreateTime()` Output only.
`boolean`	`hasDeleteTime()` Output only.
`int`	`hashCode()`
`boolean`	`hasMachineConfig()` Configurations for the machines that host the underlying database engine.
`boolean`	`hasNetworkConfig()` Optional.
`boolean`	`hasObservabilityConfig()` Configuration for observability.
`boolean`	`hasPscInstanceConfig()` Optional.
`boolean`	`hasQueryInsightsConfig()` Configuration for query insights.
`boolean`	`hasReadPoolConfig()` Read pool instance configuration.
`boolean`	`hasUpdateTime()` Output only.
`boolean`	`hasWritableNode()` Output only.
`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)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
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, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UID_FIELD_NUMBER
```
public static final int UID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATE_TIME_FIELD_NUMBER
```
public static final int CREATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UPDATE_TIME_FIELD_NUMBER
```
public static final int UPDATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DELETE_TIME_FIELD_NUMBER
```
public static final int DELETE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STATE_FIELD_NUMBER
```
public static final int STATE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INSTANCE_TYPE_FIELD_NUMBER
```
public static final int INSTANCE_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MACHINE_CONFIG_FIELD_NUMBER
```
public static final int MACHINE_CONFIG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- AVAILABILITY_TYPE_FIELD_NUMBER
```
public static final int AVAILABILITY_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- GCE_ZONE_FIELD_NUMBER
```
public static final int GCE_ZONE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DATABASE_FLAGS_FIELD_NUMBER
```
public static final int DATABASE_FLAGS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- WRITABLE_NODE_FIELD_NUMBER
```
public static final int WRITABLE_NODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NODES_FIELD_NUMBER
```
public static final int NODES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- QUERY_INSIGHTS_CONFIG_FIELD_NUMBER
```
public static final int QUERY_INSIGHTS_CONFIG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OBSERVABILITY_CONFIG_FIELD_NUMBER
```
public static final int OBSERVABILITY_CONFIG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- READ_POOL_CONFIG_FIELD_NUMBER
```
public static final int READ_POOL_CONFIG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- IP_ADDRESS_FIELD_NUMBER
```
public static final int IP_ADDRESS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PUBLIC_IP_ADDRESS_FIELD_NUMBER
```
public static final int PUBLIC_IP_ADDRESS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RECONCILING_FIELD_NUMBER
```
public static final int RECONCILING_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ETAG_FIELD_NUMBER
```
public static final int ETAG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ANNOTATIONS_FIELD_NUMBER
```
public static final int ANNOTATIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CLIENT_CONNECTION_CONFIG_FIELD_NUMBER
```
public static final int CLIENT_CONNECTION_CONFIG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SATISFIES_PZS_FIELD_NUMBER
```
public static final int SATISFIES_PZS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PSC_INSTANCE_CONFIG_FIELD_NUMBER
```
public static final int PSC_INSTANCE_CONFIG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NETWORK_CONFIG_FIELD_NUMBER
```
public static final int NETWORK_CONFIG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OUTBOUND_PUBLIC_IP_ADDRESSES_FIELD_NUMBER
```
public static final int OUTBOUND_PUBLIC_IP_ADDRESSES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public 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];

Specified by:: getName in interface InstanceOrBuilder
Returns:: The name.

getNameBytes

public 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];

Specified by:: getNameBytes in interface InstanceOrBuilder
Returns:: The bytes for name.

getDisplayName
```
public String getDisplayName()
```
```
 User-settable and human-readable display name for the Instance.
 
```
string display_name = 2;
Specified by:

getDisplayName in interface InstanceOrBuilder

Returns:

The displayName.

getDisplayNameBytes
```
public com.google.protobuf.ByteString getDisplayNameBytes()
```
```
 User-settable and human-readable display name for the Instance.
 
```
string display_name = 2;
Specified by:

getDisplayNameBytes in interface InstanceOrBuilder

Returns:

The bytes for displayName.

getUid

public 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];

Specified by:: getUid in interface InstanceOrBuilder
Returns:: The uid.

getUidBytes

public 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];

Specified by:: getUidBytes in interface InstanceOrBuilder
Returns:: The bytes for uid.

hasCreateTime
```
public boolean hasCreateTime()
```
```
 Output only. Create time stamp
 
```
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasCreateTime in interface InstanceOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime
```
public com.google.protobuf.Timestamp getCreateTime()
```
```
 Output only. Create time stamp
 
```
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getCreateTime in interface InstanceOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
```
```
 Output only. Create time stamp
 
```
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getCreateTimeOrBuilder in interface InstanceOrBuilder

hasUpdateTime
```
public boolean hasUpdateTime()
```
```
 Output only. Update time stamp
 
```
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasUpdateTime in interface InstanceOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime
```
public com.google.protobuf.Timestamp getUpdateTime()
```
```
 Output only. Update time stamp
 
```
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUpdateTime in interface InstanceOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
```
```
 Output only. Update time stamp
 
```
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUpdateTimeOrBuilder in interface InstanceOrBuilder

hasDeleteTime
```
public boolean hasDeleteTime()
```
```
 Output only. Delete time stamp
 
```
.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasDeleteTime in interface InstanceOrBuilder

Returns:

Whether the deleteTime field is set.

getDeleteTime
```
public com.google.protobuf.Timestamp getDeleteTime()
```
```
 Output only. Delete time stamp
 
```
.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getDeleteTime in interface InstanceOrBuilder

Returns:

The deleteTime.

getDeleteTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
```
```
 Output only. Delete time stamp
 
```
.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getDeleteTimeOrBuilder in interface InstanceOrBuilder

getLabelsCount
```
public int getLabelsCount()
```
Description copied from interface: InstanceOrBuilder
```
 Labels as key value pairs
 
```
map<string, string> labels = 7;
Specified by:

getLabelsCount in interface InstanceOrBuilder

containsLabels
```
public boolean containsLabels(String key)
```
```
 Labels as key value pairs
 
```
map<string, string> labels = 7;
Specified by:

containsLabels in interface InstanceOrBuilder

getLabels
```
@Deprecated
public Map<String,String> getLabels()
```
Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface InstanceOrBuilder

getLabelsMap
```
public Map<String,String> getLabelsMap()
```
```
 Labels as key value pairs
 
```
map<string, string> labels = 7;
Specified by:

getLabelsMap in interface InstanceOrBuilder

getLabelsOrDefault

public String getLabelsOrDefault(String key,
                                 String defaultValue)

 Labels as key value pairs

map<string, string> labels = 7;

Specified by:: getLabelsOrDefault in interface InstanceOrBuilder

getLabelsOrThrow
```
public String getLabelsOrThrow(String key)
```
```
 Labels as key value pairs
 
```
map<string, string> labels = 7;
Specified by:

getLabelsOrThrow in interface InstanceOrBuilder

getStateValue
```
public int getStateValue()
```
```
 Output only. The current serving state of the instance.
 
```
.google.cloud.alloydb.v1.Instance.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getStateValue in interface InstanceOrBuilder

Returns:

The enum numeric value on the wire for state.

getState
```
public Instance.State getState()
```
```
 Output only. The current serving state of the instance.
 
```
.google.cloud.alloydb.v1.Instance.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getState in interface InstanceOrBuilder

Returns:

The state.

getInstanceTypeValue
```
public int getInstanceTypeValue()
```
```
 Required. The type of the instance. Specified at creation time.
 
```
.google.cloud.alloydb.v1.Instance.InstanceType instance_type = 9 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getInstanceTypeValue in interface InstanceOrBuilder

Returns:

The enum numeric value on the wire for instanceType.

getInstanceType
```
public Instance.InstanceType getInstanceType()
```
```
 Required. The type of the instance. Specified at creation time.
 
```
.google.cloud.alloydb.v1.Instance.InstanceType instance_type = 9 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getInstanceType in interface InstanceOrBuilder

Returns:

The instanceType.

hasMachineConfig
```
public boolean hasMachineConfig()
```
```
 Configurations for the machines that host the underlying
 database engine.
 
```
.google.cloud.alloydb.v1.Instance.MachineConfig machine_config = 10;
Specified by:

hasMachineConfig in interface InstanceOrBuilder

Returns:

Whether the machineConfig field is set.

getMachineConfig
```
public Instance.MachineConfig getMachineConfig()
```
```
 Configurations for the machines that host the underlying
 database engine.
 
```
.google.cloud.alloydb.v1.Instance.MachineConfig machine_config = 10;
Specified by:

getMachineConfig in interface InstanceOrBuilder

Returns:

The machineConfig.

getMachineConfigOrBuilder
```
public Instance.MachineConfigOrBuilder getMachineConfigOrBuilder()
```
```
 Configurations for the machines that host the underlying
 database engine.
 
```
.google.cloud.alloydb.v1.Instance.MachineConfig machine_config = 10;
Specified by:

getMachineConfigOrBuilder in interface InstanceOrBuilder

getAvailabilityTypeValue

public 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.v1.Instance.AvailabilityType availability_type = 11;

Specified by:: getAvailabilityTypeValue in interface InstanceOrBuilder
Returns:: The enum numeric value on the wire for availabilityType.

getAvailabilityType

public 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.v1.Instance.AvailabilityType availability_type = 11;

Specified by:: getAvailabilityType in interface InstanceOrBuilder
Returns:: The availabilityType.

getGceZone

public 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;

Specified by:: getGceZone in interface InstanceOrBuilder
Returns:: The gceZone.

getGceZoneBytes

public 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;

Specified by:: getGceZoneBytes in interface InstanceOrBuilder
Returns:: The bytes for gceZone.

getDatabaseFlagsCount

public int getDatabaseFlagsCount()

Description copied from interface: InstanceOrBuilder

 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;

Specified by:: getDatabaseFlagsCount in interface InstanceOrBuilder

containsDatabaseFlags

public boolean containsDatabaseFlags(String key)

 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;

Specified by:: containsDatabaseFlags in interface InstanceOrBuilder

getDatabaseFlags
```
@Deprecated
public Map<String,String> getDatabaseFlags()
```
Deprecated.

Use getDatabaseFlagsMap() instead.

Specified by:

getDatabaseFlags in interface InstanceOrBuilder

getDatabaseFlagsMap

public Map<String,String> 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;

Specified by:: getDatabaseFlagsMap in interface InstanceOrBuilder

getDatabaseFlagsOrDefault

public String getDatabaseFlagsOrDefault(String key,
                                        String defaultValue)

 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;

Specified by:: getDatabaseFlagsOrDefault in interface InstanceOrBuilder

getDatabaseFlagsOrThrow

public String getDatabaseFlagsOrThrow(String key)

 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;

Specified by:: getDatabaseFlagsOrThrow in interface InstanceOrBuilder

hasWritableNode
```
public boolean hasWritableNode()
```
```
 Output only. This is set for the read-write VM of the PRIMARY instance
 only.
 
```
.google.cloud.alloydb.v1.Instance.Node writable_node = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasWritableNode in interface InstanceOrBuilder

Returns:

Whether the writableNode field is set.

getWritableNode
```
public Instance.Node getWritableNode()
```
```
 Output only. This is set for the read-write VM of the PRIMARY instance
 only.
 
```
.google.cloud.alloydb.v1.Instance.Node writable_node = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getWritableNode in interface InstanceOrBuilder

Returns:

The writableNode.

getWritableNodeOrBuilder
```
public Instance.NodeOrBuilder getWritableNodeOrBuilder()
```
```
 Output only. This is set for the read-write VM of the PRIMARY instance
 only.
 
```
.google.cloud.alloydb.v1.Instance.Node writable_node = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getWritableNodeOrBuilder in interface InstanceOrBuilder

getNodesList
```
public 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.v1.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getNodesList in interface InstanceOrBuilder

getNodesOrBuilderList

public 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.v1.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:: getNodesOrBuilderList in interface InstanceOrBuilder

getNodesCount
```
public int getNodesCount()
```
```
 Output only. List of available read-only VMs in this instance, including
 the standby for a PRIMARY instance.
 
```
repeated .google.cloud.alloydb.v1.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getNodesCount in interface InstanceOrBuilder

getNodes

public Instance.Node getNodes(int index)

 Output only. List of available read-only VMs in this instance, including
 the standby for a PRIMARY instance.


 repeated .google.cloud.alloydb.v1.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:: getNodes in interface InstanceOrBuilder

getNodesOrBuilder

public Instance.NodeOrBuilder getNodesOrBuilder(int index)

 Output only. List of available read-only VMs in this instance, including
 the standby for a PRIMARY instance.


 repeated .google.cloud.alloydb.v1.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:: getNodesOrBuilder in interface InstanceOrBuilder

hasQueryInsightsConfig
```
public boolean hasQueryInsightsConfig()
```
```
 Configuration for query insights.
 
```
.google.cloud.alloydb.v1.Instance.QueryInsightsInstanceConfig query_insights_config = 21;
Specified by:

hasQueryInsightsConfig in interface InstanceOrBuilder

Returns:

Whether the queryInsightsConfig field is set.

getQueryInsightsConfig
```
public Instance.QueryInsightsInstanceConfig getQueryInsightsConfig()
```
```
 Configuration for query insights.
 
```
.google.cloud.alloydb.v1.Instance.QueryInsightsInstanceConfig query_insights_config = 21;
Specified by:

getQueryInsightsConfig in interface InstanceOrBuilder

Returns:

The queryInsightsConfig.

getQueryInsightsConfigOrBuilder
```
public Instance.QueryInsightsInstanceConfigOrBuilder getQueryInsightsConfigOrBuilder()
```
```
 Configuration for query insights.
 
```
.google.cloud.alloydb.v1.Instance.QueryInsightsInstanceConfig query_insights_config = 21;
Specified by:

getQueryInsightsConfigOrBuilder in interface InstanceOrBuilder

hasObservabilityConfig
```
public boolean hasObservabilityConfig()
```
```
 Configuration for observability.
 
```
.google.cloud.alloydb.v1.Instance.ObservabilityInstanceConfig observability_config = 26;
Specified by:

hasObservabilityConfig in interface InstanceOrBuilder

Returns:

Whether the observabilityConfig field is set.

getObservabilityConfig
```
public Instance.ObservabilityInstanceConfig getObservabilityConfig()
```
```
 Configuration for observability.
 
```
.google.cloud.alloydb.v1.Instance.ObservabilityInstanceConfig observability_config = 26;
Specified by:

getObservabilityConfig in interface InstanceOrBuilder

Returns:

The observabilityConfig.

getObservabilityConfigOrBuilder
```
public Instance.ObservabilityInstanceConfigOrBuilder getObservabilityConfigOrBuilder()
```
```
 Configuration for observability.
 
```
.google.cloud.alloydb.v1.Instance.ObservabilityInstanceConfig observability_config = 26;
Specified by:

getObservabilityConfigOrBuilder in interface InstanceOrBuilder

hasReadPoolConfig
```
public boolean hasReadPoolConfig()
```
```
 Read pool instance configuration.
 This is required if the value of instanceType is READ_POOL.
 
```
.google.cloud.alloydb.v1.Instance.ReadPoolConfig read_pool_config = 14;
Specified by:

hasReadPoolConfig in interface InstanceOrBuilder

Returns:

Whether the readPoolConfig field is set.

getReadPoolConfig
```
public Instance.ReadPoolConfig getReadPoolConfig()
```
```
 Read pool instance configuration.
 This is required if the value of instanceType is READ_POOL.
 
```
.google.cloud.alloydb.v1.Instance.ReadPoolConfig read_pool_config = 14;
Specified by:

getReadPoolConfig in interface InstanceOrBuilder

Returns:

The readPoolConfig.

getReadPoolConfigOrBuilder

public Instance.ReadPoolConfigOrBuilder getReadPoolConfigOrBuilder()

 Read pool instance configuration.
 This is required if the value of instanceType is READ_POOL.

.google.cloud.alloydb.v1.Instance.ReadPoolConfig read_pool_config = 14;

Specified by:: getReadPoolConfigOrBuilder in interface InstanceOrBuilder

getIpAddress
```
public 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];
Specified by:

getIpAddress in interface InstanceOrBuilder

Returns:

The ipAddress.

getIpAddressBytes
```
public 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];
Specified by:

getIpAddressBytes in interface InstanceOrBuilder

Returns:

The bytes for ipAddress.

getPublicIpAddress

public 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) = { ... }

Specified by:: getPublicIpAddress in interface InstanceOrBuilder
Returns:: The publicIpAddress.

getPublicIpAddressBytes

public 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) = { ... }

Specified by:: getPublicIpAddressBytes in interface InstanceOrBuilder
Returns:: The bytes for publicIpAddress.

getReconciling

public 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];

Specified by:: getReconciling in interface InstanceOrBuilder
Returns:: The reconciling.

getEtag

public String getEtag()

 For Resource freshness validation (https://google.aip.dev/154)

string etag = 17;

Specified by:: getEtag in interface InstanceOrBuilder
Returns:: The etag.

getEtagBytes

public com.google.protobuf.ByteString getEtagBytes()

 For Resource freshness validation (https://google.aip.dev/154)

string etag = 17;

Specified by:: getEtagBytes in interface InstanceOrBuilder
Returns:: The bytes for etag.