Class Instance (0.1.0)

public final class Instance extends 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Instance

Implements

InstanceOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER

Field Value

Type	Description
`int`

AVAILABILITY_TYPE_FIELD_NUMBER

public static final int AVAILABILITY_TYPE_FIELD_NUMBER

Field Value

Type	Description
`int`

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value

Type	Description
`int`

DATABASE_FLAGS_FIELD_NUMBER

public static final int DATABASE_FLAGS_FIELD_NUMBER

Field Value

Type	Description
`int`

DELETE_TIME_FIELD_NUMBER

public static final int DELETE_TIME_FIELD_NUMBER

Field Value

Type	Description
`int`

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value

Type	Description
`int`

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER

Field Value

Type	Description
`int`

GCE_ZONE_FIELD_NUMBER

public static final int GCE_ZONE_FIELD_NUMBER

Field Value

Type	Description
`int`

INSTANCE_TYPE_FIELD_NUMBER

public static final int INSTANCE_TYPE_FIELD_NUMBER

Field Value

Type	Description
`int`

IP_ADDRESS_FIELD_NUMBER

public static final int IP_ADDRESS_FIELD_NUMBER

Field Value

Type	Description
`int`

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

Field Value

Type	Description
`int`

MACHINE_CONFIG_FIELD_NUMBER

public static final int MACHINE_CONFIG_FIELD_NUMBER

Field Value

Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
`int`

NODES_FIELD_NUMBER

public static final int NODES_FIELD_NUMBER

Field Value

Type	Description
`int`

QUERY_INSIGHTS_CONFIG_FIELD_NUMBER

public static final int QUERY_INSIGHTS_CONFIG_FIELD_NUMBER

Field Value

Type	Description
`int`

READ_POOL_CONFIG_FIELD_NUMBER

public static final int READ_POOL_CONFIG_FIELD_NUMBER

Field Value

Type	Description
`int`

RECONCILING_FIELD_NUMBER

public static final int RECONCILING_FIELD_NUMBER

Field Value

Type	Description
`int`

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value

Type	Description
`int`

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER

Field Value

Type	Description
`int`

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value

Type	Description
`int`

WRITABLE_NODE_FIELD_NUMBER

public static final int WRITABLE_NODE_FIELD_NUMBER

Field Value

Type	Description
`int`

Static Methods

getDefaultInstance()

public static Instance getDefaultInstance()

Returns

Type	Description
`Instance`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
`Descriptor`

newBuilder()

public static Instance.Builder newBuilder()

Returns

Type	Description
`Instance.Builder`

newBuilder(Instance prototype)

public static Instance.Builder newBuilder(Instance prototype)

Parameter

Name	Description
`prototype`	`Instance`

Returns

Type	Description
`Instance.Builder`

parseDelimitedFrom(InputStream input)

public static Instance parseDelimitedFrom(InputStream input)

Parameter

Name	Description
`input`	`InputStream`

Returns

Type	Description
`Instance`

Exceptions

Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Instance`

Exceptions

Type	Description
`IOException`

parseFrom(byte[] data)

public static Instance parseFrom(byte[] data)

Parameter

Name	Description
`data`	`byte[]`

Returns

Type	Description
`Instance`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Instance`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Instance parseFrom(ByteString data)

Parameter

Name	Description
`data`	`ByteString`

Returns

Type	Description
`Instance`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Instance`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Instance parseFrom(CodedInputStream input)

Parameter

Name	Description
`input`	`CodedInputStream`

Returns

Type	Description
`Instance`

Exceptions

Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Instance`

Exceptions

Type	Description
`IOException`

parseFrom(InputStream input)

public static Instance parseFrom(InputStream input)

Parameter

Name	Description
`input`	`InputStream`

Returns

Type	Description
`Instance`

Exceptions

Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Instance`

Exceptions

Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Instance parseFrom(ByteBuffer data)

Parameter

Name	Description
`data`	`ByteBuffer`

Returns

Type	Description
`Instance`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Instance`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Instance> parser()

Returns

Type	Description
`Parser<Instance>`

Methods

containsAnnotations(String key)

public boolean containsAnnotations(String key)

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;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`boolean`

containsDatabaseFlags(String key)

public boolean containsDatabaseFlags(String key)

Database flags. Set at instance level.

They are copied from primary instance on read instance creation.
Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. 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;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`boolean`

containsLabels(String key)

public boolean containsLabels(String key)

Labels as key value pairs

map<string, string> labels = 7;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`boolean`

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
`obj`	`Object`

Returns

Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getAnnotations()

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns

Type	Description
`Map<String,String>`

getAnnotationsCount()

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

Returns

Type	Description
`int`

getAnnotationsMap()

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

Returns

Type	Description
`Map<String,String>`

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

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;

Parameters

Name	Description
`key`	`String`
`defaultValue`	`String`

Returns

Type	Description
`String`

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

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;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`String`

getAvailabilityType()

public Instance.AvailabilityType getAvailabilityType()

Availability type of an Instance. Defaults to REGIONAL for both primary and read instances. Note that primary and read instances can have different availability types.

.google.cloud.alloydb.v1.Instance.AvailabilityType availability_type = 11;

Returns

Type	Description
`Instance.AvailabilityType`	The availabilityType.

getAvailabilityTypeValue()

public int getAvailabilityTypeValue()

Availability type of an Instance. Defaults to REGIONAL for both primary and read instances. Note that primary and read instances can have different availability types.

.google.cloud.alloydb.v1.Instance.AvailabilityType availability_type = 11;

Returns

Type	Description
`int`	The enum numeric value on the wire for availabilityType.

getCreateTime()

public Timestamp getCreateTime()

Output only. Create time stamp

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time stamp

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`TimestampOrBuilder`

getDatabaseFlags()

public Map<String,String> getDatabaseFlags()

Use #getDatabaseFlagsMap() instead.

Returns

Type	Description
`Map<String,String>`

getDatabaseFlagsCount()

public int getDatabaseFlagsCount()

Database flags. Set at instance level.

They are copied from primary instance on read instance creation.
Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. 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;

Returns

Type	Description
`int`

getDatabaseFlagsMap()

public Map<String,String> getDatabaseFlagsMap()

Database flags. Set at instance level.

They are copied from primary instance on read instance creation.
Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. 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;

Returns

Type	Description
`Map<String,String>`

getDatabaseFlagsOrDefault(String key, String defaultValue)

public String getDatabaseFlagsOrDefault(String key, String defaultValue)

Database flags. Set at instance level.

They are copied from primary instance on read instance creation.
Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. 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;

Parameters

Name	Description
`key`	`String`
`defaultValue`	`String`

Returns

Type	Description
`String`

getDatabaseFlagsOrThrow(String key)

public String getDatabaseFlagsOrThrow(String key)

Database flags. Set at instance level.

They are copied from primary instance on read instance creation.
Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. 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;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`String`

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()

Returns

Type	Description
`Instance`

getDeleteTime()

public Timestamp getDeleteTime()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Timestamp`	The deleteTime.

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`TimestampOrBuilder`

getDisplayName()

public String getDisplayName()

User-settable and human-readable display name for the Instance.

string display_name = 2;

Returns

Type	Description
`String`	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

User-settable and human-readable display name for the Instance.

string display_name = 2;

Returns

Type	Description
`ByteString`	The bytes for displayName.

getEtag()

public String getEtag()

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

string etag = 17;

Returns

Type	Description
`String`	The etag.

getEtagBytes()

public ByteString getEtagBytes()

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

string etag = 17;

Returns

Type	Description
`ByteString`	The bytes for etag.

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;

Returns

Type	Description
`String`	The gceZone.

getGceZoneBytes()

public ByteString getGceZoneBytes()

string gce_zone = 12;

Returns

Type	Description
`ByteString`	The bytes for gceZone.

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

Returns

Type	Description
`Instance.InstanceType`	The instanceType.

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

Returns

Type	Description
`int`	The enum numeric value on the wire for instanceType.

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

Returns

Type	Description
`String`	The ipAddress.

getIpAddressBytes()

public 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

Type	Description
`ByteString`	The bytes for ipAddress.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
`Map<String,String>`

getLabelsCount()

public int getLabelsCount()

Labels as key value pairs

map<string, string> labels = 7;

Returns

Type	Description
`int`

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels as key value pairs

map<string, string> labels = 7;

Returns

Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs

map<string, string> labels = 7;

Parameters

Name	Description
`key`	`String`
`defaultValue`	`String`

Returns

Type	Description
`String`

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels as key value pairs

map<string, string> labels = 7;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`String`

getMachineConfig()

public Instance.MachineConfig getMachineConfig()

Configurations for the machines that host the underlying database engine.

.google.cloud.alloydb.v1.Instance.MachineConfig machine_config = 10;

Returns

Type	Description
`Instance.MachineConfig`	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;

Returns

Type	Description
`Instance.MachineConfigOrBuilder`

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?, 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

Type	Description
`String`	The name.

getNameBytes()

public 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?, 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

Type	Description
`ByteString`	The bytes for name.

getNodes(int index)

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

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`Instance.Node`

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

Returns

Type	Description
`int`

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

Returns

Type	Description
`List<Node>`

getNodesOrBuilder(int index)

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

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`Instance.NodeOrBuilder`

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

Returns

Type	Description
`List<? extends com.google.cloud.alloydb.v1.Instance.NodeOrBuilder>`

getParserForType()

public Parser<Instance> getParserForType()

Returns

Type	Description
`Parser<Instance>`

Overrides

GeneratedMessageV3.getParserForType()

getQueryInsightsConfig()

public Instance.QueryInsightsInstanceConfig getQueryInsightsConfig()

Configuration for query insights.

.google.cloud.alloydb.v1.Instance.QueryInsightsInstanceConfig query_insights_config = 21;

Returns

Type	Description
`Instance.QueryInsightsInstanceConfig`	The queryInsightsConfig.

getQueryInsightsConfigOrBuilder()

public Instance.QueryInsightsInstanceConfigOrBuilder getQueryInsightsConfigOrBuilder()

Configuration for query insights.

.google.cloud.alloydb.v1.Instance.QueryInsightsInstanceConfig query_insights_config = 21;

Returns

Type	Description
`Instance.QueryInsightsInstanceConfigOrBuilder`

getReadPoolConfig()

public Instance.ReadPoolConfig getReadPoolConfig()

Read pool specific config.

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

Returns

Type	Description
`Instance.ReadPoolConfig`	The readPoolConfig.

getReadPoolConfigOrBuilder()

public Instance.ReadPoolConfigOrBuilder getReadPoolConfigOrBuilder()

Read pool specific config.

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

Returns

Type	Description
`Instance.ReadPoolConfigOrBuilder`

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

Returns

Type	Description
`boolean`	The reconciling.

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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

Returns

Type	Description
`Instance.State`	The state.

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

Returns

Type	Description
`int`	The enum numeric value on the wire for state.

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

Returns

Type	Description
`String`	The uid.

getUidBytes()

public 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

Type	Description
`ByteString`	The bytes for uid.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
`UnknownFieldSet`

Overrides

GeneratedMessageV3.getUnknownFields()

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`Timestamp`	The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`TimestampOrBuilder`

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

Returns

Type	Description
`Instance.Node`	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];

Returns

Type	Description
`Instance.NodeOrBuilder`

hasCreateTime()

public boolean hasCreateTime()

Output only. Create time stamp

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	Whether the createTime field is set.

hasDeleteTime()

public boolean hasDeleteTime()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	Whether the deleteTime field is set.

hasMachineConfig()

public boolean hasMachineConfig()

Configurations for the machines that host the underlying database engine.

.google.cloud.alloydb.v1.Instance.MachineConfig machine_config = 10;

Returns

Type	Description
`boolean`	Whether the machineConfig field is set.

hasQueryInsightsConfig()

public boolean hasQueryInsightsConfig()

Configuration for query insights.

.google.cloud.alloydb.v1.Instance.QueryInsightsInstanceConfig query_insights_config = 21;

Returns

Type	Description
`boolean`	Whether the queryInsightsConfig field is set.

hasReadPoolConfig()

public boolean hasReadPoolConfig()

Read pool specific config.

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

Returns

Type	Description
`boolean`	Whether the readPoolConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
`boolean`	Whether the updateTime field is set.

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

Returns

Type	Description
`boolean`	Whether the writableNode field is set.

hashCode()

public int hashCode()

Returns

Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
`number`	`int`

Returns

Type	Description
`MapField`

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Instance.Builder newBuilderForType()

Returns

Type	Description
`Instance.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
`parent`	`BuilderParent`

Returns

Type	Description
`Instance.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
`unused`	`UnusedPrivateParameter`

Returns

Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Instance.Builder toBuilder()

Returns

Type	Description
`Instance.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
`IOException`