Class Instance.Builder (0.43.0) 

public static final class Instance.Builder extends GeneratedMessageV3.Builder<Instance.Builder> 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.v1beta.Instance

Inheritance

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

Implements

InstanceOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllNodes(Iterable<? extends Instance.Node> values)

public Instance.Builder addAllNodes(Iterable<? extends Instance.Node> values)

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.alloydb.v1beta.Instance.Node>
Returns
Type Description
Instance.Builder

addAllOutboundPublicIpAddresses(Iterable<String> values)

public Instance.Builder addAllOutboundPublicIpAddresses(Iterable<String> values)

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

Parameter
Name Description
values Iterable<String>

The outboundPublicIpAddresses to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addNodes(Instance.Node value)

public Instance.Builder addNodes(Instance.Node value)

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

Parameter
Name Description
value Instance.Node
Returns
Type Description
Instance.Builder

addNodes(Instance.Node.Builder builderForValue)

public Instance.Builder addNodes(Instance.Node.Builder builderForValue)

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

Parameter
Name Description
builderForValue Instance.Node.Builder
Returns
Type Description
Instance.Builder

addNodes(int index, Instance.Node value)

public Instance.Builder addNodes(int index, Instance.Node value)

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

Parameters
Name Description
index int
value Instance.Node
Returns
Type Description
Instance.Builder

addNodes(int index, Instance.Node.Builder builderForValue)

public Instance.Builder addNodes(int index, Instance.Node.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue Instance.Node.Builder
Returns
Type Description
Instance.Builder

addNodesBuilder()

public Instance.Node.Builder addNodesBuilder()

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

Returns
Type Description
Instance.Node.Builder

addNodesBuilder(int index)

public Instance.Node.Builder addNodesBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
Instance.Node.Builder

addOutboundPublicIpAddresses(String value)

public Instance.Builder addOutboundPublicIpAddresses(String value)

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

Parameter
Name Description
value String

The outboundPublicIpAddresses to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addOutboundPublicIpAddressesBytes(ByteString value)

public Instance.Builder addOutboundPublicIpAddressesBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes of the outboundPublicIpAddresses to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Instance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Instance.Builder
Overrides

build()

public Instance build()
Returns
Type Description
Instance

buildPartial()

public Instance buildPartial()
Returns
Type Description
Instance

clear()

public Instance.Builder clear()
Returns
Type Description
Instance.Builder
Overrides

clearAnnotations()

public Instance.Builder clearAnnotations()
Returns
Type Description
Instance.Builder

clearAvailabilityType()

public Instance.Builder clearAvailabilityType()

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
Type Description
Instance.Builder

This builder for chaining.

clearClientConnectionConfig()

public Instance.Builder clearClientConnectionConfig()

Optional. Client connection specific configurations

.google.cloud.alloydb.v1beta.Instance.ClientConnectionConfig client_connection_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.Builder

clearCreateTime()

public Instance.Builder clearCreateTime()

Output only. Create time stamp

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

Returns
Type Description
Instance.Builder

clearDatabaseFlags()

public Instance.Builder clearDatabaseFlags()
Returns
Type Description
Instance.Builder

clearDeleteTime()

public Instance.Builder clearDeleteTime()

Output only. Delete time stamp

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

Returns
Type Description
Instance.Builder

clearDisplayName()

public Instance.Builder clearDisplayName()

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

string display_name = 2;

Returns
Type Description
Instance.Builder

This builder for chaining.

clearEtag()

public Instance.Builder clearEtag()

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

string etag = 17;

Returns
Type Description
Instance.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Instance.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Instance.Builder
Overrides

clearGceZone()

public Instance.Builder clearGceZone()

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
Instance.Builder

This builder for chaining.

clearGeminiConfig()

public Instance.Builder clearGeminiConfig()

Optional. Configuration parameters related to the Gemini in Databases add-on.

.google.cloud.alloydb.v1beta.GeminiInstanceConfig gemini_config = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.Builder

clearInstanceType()

public Instance.Builder clearInstanceType()

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
Type Description
Instance.Builder

This builder for chaining.

clearIpAddress()

public Instance.Builder clearIpAddress()

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
Instance.Builder

This builder for chaining.

clearLabels()

public Instance.Builder clearLabels()
Returns
Type Description
Instance.Builder

clearMachineConfig()

public Instance.Builder clearMachineConfig()

Configurations for the machines that host the underlying database engine.

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

Returns
Type Description
Instance.Builder

clearName()

public Instance.Builder clearName()

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
Instance.Builder

This builder for chaining.

clearNetworkConfig()

public Instance.Builder clearNetworkConfig()

Optional. Instance-level network configuration.

.google.cloud.alloydb.v1beta.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.Builder

clearNodes()

public Instance.Builder clearNodes()

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

Returns
Type Description
Instance.Builder

clearObservabilityConfig()

public Instance.Builder clearObservabilityConfig()

Configuration for observability.

.google.cloud.alloydb.v1beta.Instance.ObservabilityInstanceConfig observability_config = 26;

Returns
Type Description
Instance.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Instance.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Instance.Builder
Overrides

clearOutboundPublicIpAddresses()

public Instance.Builder clearOutboundPublicIpAddresses()

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
Type Description
Instance.Builder

This builder for chaining.

clearPscInstanceConfig()

public Instance.Builder clearPscInstanceConfig()

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
Type Description
Instance.Builder

clearPublicIpAddress()

public Instance.Builder clearPublicIpAddress()

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
Type Description
Instance.Builder

This builder for chaining.

clearQueryInsightsConfig()

public Instance.Builder clearQueryInsightsConfig()

Configuration for query insights.

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

Returns
Type Description
Instance.Builder

clearReadPoolConfig()

public Instance.Builder clearReadPoolConfig()

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
Type Description
Instance.Builder

clearReconciling()

public Instance.Builder clearReconciling()

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
Instance.Builder

This builder for chaining.

clearSatisfiesPzs()

public Instance.Builder clearSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearState()

public Instance.Builder clearState()

Output only. The current serving state of the instance.

.google.cloud.alloydb.v1beta.Instance.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearUid()

public Instance.Builder clearUid()

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
Instance.Builder

This builder for chaining.

clearUpdatePolicy()

public Instance.Builder clearUpdatePolicy()

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
Type Description
Instance.Builder

clearUpdateTime()

public Instance.Builder clearUpdateTime()

Output only. Update time stamp

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

Returns
Type Description
Instance.Builder

clearWritableNode()

public Instance.Builder clearWritableNode()

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
Type Description
Instance.Builder

clone()

public Instance.Builder clone()
Returns
Type Description
Instance.Builder
Overrides

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

getAnnotations() (deprecated)

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. 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
Type Description
Instance.AvailabilityType

The availabilityType.

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

Returns
Type Description
int

The enum numeric value on the wire for availabilityType.

getClientConnectionConfig()

public Instance.ClientConnectionConfig getClientConnectionConfig()

Optional. Client connection specific configurations

.google.cloud.alloydb.v1beta.Instance.ClientConnectionConfig client_connection_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.ClientConnectionConfig

The clientConnectionConfig.

getClientConnectionConfigBuilder()

public Instance.ClientConnectionConfig.Builder getClientConnectionConfigBuilder()

Optional. Client connection specific configurations

.google.cloud.alloydb.v1beta.Instance.ClientConnectionConfig client_connection_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.ClientConnectionConfig.Builder

getClientConnectionConfigOrBuilder()

public Instance.ClientConnectionConfigOrBuilder getClientConnectionConfigOrBuilder()

Optional. Client connection specific configurations

.google.cloud.alloydb.v1beta.Instance.ClientConnectionConfig client_connection_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.ClientConnectionConfigOrBuilder

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Create time stamp

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

Returns
Type Description
Builder

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() (deprecated)

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.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

Output only. Delete time stamp

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

Returns
Type Description
Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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()

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
ByteString

The bytes for gceZone.

getGeminiConfig()

public GeminiInstanceConfig getGeminiConfig()

Optional. Configuration parameters related to the Gemini in Databases add-on.

.google.cloud.alloydb.v1beta.GeminiInstanceConfig gemini_config = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GeminiInstanceConfig

The geminiConfig.

getGeminiConfigBuilder()

public GeminiInstanceConfig.Builder getGeminiConfigBuilder()

Optional. Configuration parameters related to the Gemini in Databases add-on.

.google.cloud.alloydb.v1beta.GeminiInstanceConfig gemini_config = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GeminiInstanceConfig.Builder

getGeminiConfigOrBuilder()

public GeminiInstanceConfigOrBuilder getGeminiConfigOrBuilder()

Optional. Configuration parameters related to the Gemini in Databases add-on.

.google.cloud.alloydb.v1beta.GeminiInstanceConfig gemini_config = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GeminiInstanceConfigOrBuilder

getInstanceType()

public 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
Type Description
Instance.InstanceType

The instanceType.

getInstanceTypeValue()

public 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
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() (deprecated)

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.v1beta.Instance.MachineConfig machine_config = 10;

Returns
Type Description
Instance.MachineConfig

The machineConfig.

getMachineConfigBuilder()

public Instance.MachineConfig.Builder getMachineConfigBuilder()

Configurations for the machines that host the underlying database engine.

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

Returns
Type Description
Instance.MachineConfig.Builder

getMachineConfigOrBuilder()

public Instance.MachineConfigOrBuilder getMachineConfigOrBuilder()

Configurations for the machines that host the underlying database engine.

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

Returns
Type Description
Instance.MachineConfigOrBuilder

getMutableAnnotations() (deprecated)

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableDatabaseFlags() (deprecated)

public Map<String,String> getMutableDatabaseFlags()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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.

getNetworkConfig()

public Instance.InstanceNetworkConfig getNetworkConfig()

Optional. Instance-level network configuration.

.google.cloud.alloydb.v1beta.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.InstanceNetworkConfig

The networkConfig.

getNetworkConfigBuilder()

public Instance.InstanceNetworkConfig.Builder getNetworkConfigBuilder()

Optional. Instance-level network configuration.

.google.cloud.alloydb.v1beta.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.InstanceNetworkConfig.Builder

getNetworkConfigOrBuilder()

public Instance.InstanceNetworkConfigOrBuilder getNetworkConfigOrBuilder()

Optional. Instance-level network configuration.

.google.cloud.alloydb.v1beta.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.InstanceNetworkConfigOrBuilder

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

Parameter
Name Description
index int
Returns
Type Description
Instance.Node

getNodesBuilder(int index)

public Instance.Node.Builder getNodesBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
Instance.Node.Builder

getNodesBuilderList()

public List<Instance.Node.Builder> getNodesBuilderList()

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

Returns
Type Description
List<Builder>

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

Returns
Type Description
List<? extends com.google.cloud.alloydb.v1beta.Instance.NodeOrBuilder>

getObservabilityConfig()

public Instance.ObservabilityInstanceConfig getObservabilityConfig()

Configuration for observability.

.google.cloud.alloydb.v1beta.Instance.ObservabilityInstanceConfig observability_config = 26;

Returns
Type Description
Instance.ObservabilityInstanceConfig

The observabilityConfig.

getObservabilityConfigBuilder()

public Instance.ObservabilityInstanceConfig.Builder getObservabilityConfigBuilder()

Configuration for observability.

.google.cloud.alloydb.v1beta.Instance.ObservabilityInstanceConfig observability_config = 26;

Returns
Type Description
Instance.ObservabilityInstanceConfig.Builder

getObservabilityConfigOrBuilder()

public Instance.ObservabilityInstanceConfigOrBuilder getObservabilityConfigOrBuilder()

Configuration for observability.

.google.cloud.alloydb.v1beta.Instance.ObservabilityInstanceConfig observability_config = 26;

Returns
Type Description
Instance.ObservabilityInstanceConfigOrBuilder

getOutboundPublicIpAddresses(int index)

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

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The outboundPublicIpAddresses at the given index.

getOutboundPublicIpAddressesBytes(int index)

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

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the outboundPublicIpAddresses at the given index.

getOutboundPublicIpAddressesCount()

public 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
Type Description
int

The count of outboundPublicIpAddresses.

getOutboundPublicIpAddressesList()

public ProtocolStringList 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
Type Description
ProtocolStringList

A list containing the outboundPublicIpAddresses.

getPscInstanceConfig()

public 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
Type Description
Instance.PscInstanceConfig

The pscInstanceConfig.

getPscInstanceConfigBuilder()

public Instance.PscInstanceConfig.Builder getPscInstanceConfigBuilder()

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
Type Description
Instance.PscInstanceConfig.Builder

getPscInstanceConfigOrBuilder()

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

Returns
Type Description
Instance.PscInstanceConfigOrBuilder

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

Returns
Type Description
String

The publicIpAddress.

getPublicIpAddressBytes()

public 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
Type Description
ByteString

The bytes for publicIpAddress.

getQueryInsightsConfig()

public Instance.QueryInsightsInstanceConfig getQueryInsightsConfig()

Configuration for query insights.

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

Returns
Type Description
Instance.QueryInsightsInstanceConfig

The queryInsightsConfig.

getQueryInsightsConfigBuilder()

public Instance.QueryInsightsInstanceConfig.Builder getQueryInsightsConfigBuilder()

Configuration for query insights.

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

Returns
Type Description
Instance.QueryInsightsInstanceConfig.Builder

getQueryInsightsConfigOrBuilder()

public Instance.QueryInsightsInstanceConfigOrBuilder getQueryInsightsConfigOrBuilder()

Configuration for query insights.

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

Returns
Type Description
Instance.QueryInsightsInstanceConfigOrBuilder

getReadPoolConfig()

public 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
Type Description
Instance.ReadPoolConfig

The readPoolConfig.

getReadPoolConfigBuilder()

public Instance.ReadPoolConfig.Builder getReadPoolConfigBuilder()

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
Type Description
Instance.ReadPoolConfig.Builder

getReadPoolConfigOrBuilder()

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

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.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getState()

public 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
Type Description
Instance.State

The state.

getStateValue()

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

getUpdatePolicy()

public 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
Type Description
Instance.UpdatePolicy

The updatePolicy.

getUpdatePolicyBuilder()

public Instance.UpdatePolicy.Builder getUpdatePolicyBuilder()

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
Type Description
Instance.UpdatePolicy.Builder

getUpdatePolicyOrBuilder()

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

Returns
Type Description
Instance.UpdatePolicyOrBuilder

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Update time stamp

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

Returns
Type Description
Builder

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.v1beta.Instance.Node writable_node = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Node

The writableNode.

getWritableNodeBuilder()

public Instance.Node.Builder getWritableNodeBuilder()

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
Type Description
Instance.Node.Builder

getWritableNodeOrBuilder()

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

Returns
Type Description
Instance.NodeOrBuilder

hasClientConnectionConfig()

public boolean hasClientConnectionConfig()

Optional. Client connection specific configurations

.google.cloud.alloydb.v1beta.Instance.ClientConnectionConfig client_connection_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the clientConnectionConfig field is set.

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.

hasGeminiConfig()

public boolean hasGeminiConfig()

Optional. Configuration parameters related to the Gemini in Databases add-on.

.google.cloud.alloydb.v1beta.GeminiInstanceConfig gemini_config = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the geminiConfig field is set.

hasMachineConfig()

public boolean hasMachineConfig()

Configurations for the machines that host the underlying database engine.

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

Returns
Type Description
boolean

Whether the machineConfig field is set.

hasNetworkConfig()

public boolean hasNetworkConfig()

Optional. Instance-level network configuration.

.google.cloud.alloydb.v1beta.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the networkConfig field is set.

hasObservabilityConfig()

public boolean hasObservabilityConfig()

Configuration for observability.

.google.cloud.alloydb.v1beta.Instance.ObservabilityInstanceConfig observability_config = 26;

Returns
Type Description
boolean

Whether the observabilityConfig field is set.

hasPscInstanceConfig()

public 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
Type Description
boolean

Whether the pscInstanceConfig field is set.

hasQueryInsightsConfig()

public boolean hasQueryInsightsConfig()

Configuration for query insights.

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

Returns
Type Description
boolean

Whether the queryInsightsConfig field is set.

hasReadPoolConfig()

public 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
Type Description
boolean

Whether the readPoolConfig field is set.

hasUpdatePolicy()

public 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
Type Description
boolean

Whether the updatePolicy 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.v1beta.Instance.Node writable_node = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the writableNode field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeClientConnectionConfig(Instance.ClientConnectionConfig value)

public Instance.Builder mergeClientConnectionConfig(Instance.ClientConnectionConfig value)

Optional. Client connection specific configurations

.google.cloud.alloydb.v1beta.Instance.ClientConnectionConfig client_connection_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Instance.ClientConnectionConfig
Returns
Type Description
Instance.Builder

mergeCreateTime(Timestamp value)

public Instance.Builder mergeCreateTime(Timestamp value)

Output only. Create time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Instance.Builder

mergeDeleteTime(Timestamp value)

public Instance.Builder mergeDeleteTime(Timestamp value)

Output only. Delete time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Instance.Builder

mergeFrom(Instance other)

public Instance.Builder mergeFrom(Instance other)
Parameter
Name Description
other Instance
Returns
Type Description
Instance.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Instance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Instance.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Instance.Builder
Overrides

mergeGeminiConfig(GeminiInstanceConfig value)

public Instance.Builder mergeGeminiConfig(GeminiInstanceConfig value)

Optional. Configuration parameters related to the Gemini in Databases add-on.

.google.cloud.alloydb.v1beta.GeminiInstanceConfig gemini_config = 33 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value GeminiInstanceConfig
Returns
Type Description
Instance.Builder

mergeMachineConfig(Instance.MachineConfig value)

public Instance.Builder mergeMachineConfig(Instance.MachineConfig value)

Configurations for the machines that host the underlying database engine.

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

Parameter
Name Description
value Instance.MachineConfig
Returns
Type Description
Instance.Builder

mergeNetworkConfig(Instance.InstanceNetworkConfig value)

public Instance.Builder mergeNetworkConfig(Instance.InstanceNetworkConfig value)

Optional. Instance-level network configuration.

.google.cloud.alloydb.v1beta.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Instance.InstanceNetworkConfig
Returns
Type Description
Instance.Builder

mergeObservabilityConfig(Instance.ObservabilityInstanceConfig value)

public Instance.Builder mergeObservabilityConfig(Instance.ObservabilityInstanceConfig value)

Configuration for observability.

.google.cloud.alloydb.v1beta.Instance.ObservabilityInstanceConfig observability_config = 26;

Parameter
Name Description
value Instance.ObservabilityInstanceConfig
Returns
Type Description
Instance.Builder

mergePscInstanceConfig(Instance.PscInstanceConfig value)

public Instance.Builder mergePscInstanceConfig(Instance.PscInstanceConfig value)

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

Parameter
Name Description
value Instance.PscInstanceConfig
Returns
Type Description
Instance.Builder

mergeQueryInsightsConfig(Instance.QueryInsightsInstanceConfig value)

public Instance.Builder mergeQueryInsightsConfig(Instance.QueryInsightsInstanceConfig value)

Configuration for query insights.

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

Parameter
Name Description
value Instance.QueryInsightsInstanceConfig
Returns
Type Description
Instance.Builder

mergeReadPoolConfig(Instance.ReadPoolConfig value)

public Instance.Builder mergeReadPoolConfig(Instance.ReadPoolConfig value)

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;

Parameter
Name Description
value Instance.ReadPoolConfig
Returns
Type Description
Instance.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Instance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Instance.Builder
Overrides

mergeUpdatePolicy(Instance.UpdatePolicy value)

public Instance.Builder mergeUpdatePolicy(Instance.UpdatePolicy value)

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;

Parameter
Name Description
value Instance.UpdatePolicy
Returns
Type Description
Instance.Builder

mergeUpdateTime(Timestamp value)

public Instance.Builder mergeUpdateTime(Timestamp value)

Output only. Update time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Instance.Builder

mergeWritableNode(Instance.Node value)

public Instance.Builder mergeWritableNode(Instance.Node value)

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

Parameter
Name Description
value Instance.Node
Returns
Type Description
Instance.Builder

putAllAnnotations(Map<String,String> values)

public Instance.Builder putAllAnnotations(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
Instance.Builder

putAllDatabaseFlags(Map<String,String> values)

public Instance.Builder putAllDatabaseFlags(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
Instance.Builder

putAllLabels(Map<String,String> values)

public Instance.Builder putAllLabels(Map<String,String> values)

Labels as key value pairs

map<string, string> labels = 7;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Instance.Builder

putAnnotations(String key, String value)

public Instance.Builder putAnnotations(String key, String value)

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
value String
Returns
Type Description
Instance.Builder

putDatabaseFlags(String key, String value)

public Instance.Builder putDatabaseFlags(String key, String value)

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
value String
Returns
Type Description
Instance.Builder

putLabels(String key, String value)

public Instance.Builder putLabels(String key, String value)

Labels as key value pairs

map<string, string> labels = 7;

Parameters
Name Description
key String
value String
Returns
Type Description
Instance.Builder

removeAnnotations(String key)

public Instance.Builder removeAnnotations(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
Instance.Builder

removeDatabaseFlags(String key)

public Instance.Builder removeDatabaseFlags(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
Instance.Builder

removeLabels(String key)

public Instance.Builder removeLabels(String key)

Labels as key value pairs

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
Instance.Builder

removeNodes(int index)

public Instance.Builder removeNodes(int index)

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

Parameter
Name Description
index int
Returns
Type Description
Instance.Builder

setAvailabilityType(Instance.AvailabilityType value)

public Instance.Builder setAvailabilityType(Instance.AvailabilityType value)

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;

Parameter
Name Description
value Instance.AvailabilityType

The availabilityType to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setAvailabilityTypeValue(int value)

public Instance.Builder setAvailabilityTypeValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for availabilityType to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setClientConnectionConfig(Instance.ClientConnectionConfig value)

public Instance.Builder setClientConnectionConfig(Instance.ClientConnectionConfig value)

Optional. Client connection specific configurations

.google.cloud.alloydb.v1beta.Instance.ClientConnectionConfig client_connection_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Instance.ClientConnectionConfig
Returns
Type Description
Instance.Builder

setClientConnectionConfig(Instance.ClientConnectionConfig.Builder builderForValue)

public Instance.Builder setClientConnectionConfig(Instance.ClientConnectionConfig.Builder builderForValue)

Optional. Client connection specific configurations

.google.cloud.alloydb.v1beta.Instance.ClientConnectionConfig client_connection_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Instance.ClientConnectionConfig.Builder
Returns
Type Description
Instance.Builder

setCreateTime(Timestamp value)

public Instance.Builder setCreateTime(Timestamp value)

Output only. Create time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Instance.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Instance.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Create time stamp

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Instance.Builder

setDeleteTime(Timestamp value)

public Instance.Builder setDeleteTime(Timestamp value)

Output only. Delete time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Instance.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public Instance.Builder setDeleteTime(Timestamp.Builder builderForValue)

Output only. Delete time stamp

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Instance.Builder

setDisplayName(String value)

public Instance.Builder setDisplayName(String value)

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

string display_name = 2;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Instance.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 2;

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setEtag(String value)

public Instance.Builder setEtag(String value)

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

string etag = 17;

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Instance.Builder setEtagBytes(ByteString value)

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

string etag = 17;

Parameter
Name Description
value ByteString

The bytes for etag to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Instance.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Instance.Builder
Overrides

setGceZone(String value)

public Instance.Builder setGceZone(String value)

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;

Parameter
Name Description
value String

The gceZone to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setGceZoneBytes(ByteString value)

public Instance.Builder setGceZoneBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for gceZone to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setGeminiConfig(GeminiInstanceConfig value)

public Instance.Builder setGeminiConfig(GeminiInstanceConfig value)

Optional. Configuration parameters related to the Gemini in Databases add-on.

.google.cloud.alloydb.v1beta.GeminiInstanceConfig gemini_config = 33 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value GeminiInstanceConfig
Returns
Type Description
Instance.Builder

setGeminiConfig(GeminiInstanceConfig.Builder builderForValue)

public Instance.Builder setGeminiConfig(GeminiInstanceConfig.Builder builderForValue)

Optional. Configuration parameters related to the Gemini in Databases add-on.

.google.cloud.alloydb.v1beta.GeminiInstanceConfig gemini_config = 33 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue GeminiInstanceConfig.Builder
Returns
Type Description
Instance.Builder

setInstanceType(Instance.InstanceType value)

public Instance.Builder setInstanceType(Instance.InstanceType value)

Required. The type of the instance. Specified at creation time.

.google.cloud.alloydb.v1beta.Instance.InstanceType instance_type = 9 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Instance.InstanceType

The instanceType to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setInstanceTypeValue(int value)

public Instance.Builder setInstanceTypeValue(int value)

Required. The type of the instance. Specified at creation time.

.google.cloud.alloydb.v1beta.Instance.InstanceType instance_type = 9 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for instanceType to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setIpAddress(String value)

public Instance.Builder setIpAddress(String value)

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

Parameter
Name Description
value String

The ipAddress to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setIpAddressBytes(ByteString value)

public Instance.Builder setIpAddressBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for ipAddress to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setMachineConfig(Instance.MachineConfig value)

public Instance.Builder setMachineConfig(Instance.MachineConfig value)

Configurations for the machines that host the underlying database engine.

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

Parameter
Name Description
value Instance.MachineConfig
Returns
Type Description
Instance.Builder

setMachineConfig(Instance.MachineConfig.Builder builderForValue)

public Instance.Builder setMachineConfig(Instance.MachineConfig.Builder builderForValue)

Configurations for the machines that host the underlying database engine.

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

Parameter
Name Description
builderForValue Instance.MachineConfig.Builder
Returns
Type Description
Instance.Builder

setName(String value)

public Instance.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Instance.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setNetworkConfig(Instance.InstanceNetworkConfig value)

public Instance.Builder setNetworkConfig(Instance.InstanceNetworkConfig value)

Optional. Instance-level network configuration.

.google.cloud.alloydb.v1beta.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Instance.InstanceNetworkConfig
Returns
Type Description
Instance.Builder

setNetworkConfig(Instance.InstanceNetworkConfig.Builder builderForValue)

public Instance.Builder setNetworkConfig(Instance.InstanceNetworkConfig.Builder builderForValue)

Optional. Instance-level network configuration.

.google.cloud.alloydb.v1beta.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Instance.InstanceNetworkConfig.Builder
Returns
Type Description
Instance.Builder

setNodes(int index, Instance.Node value)

public Instance.Builder setNodes(int index, Instance.Node value)

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

Parameters
Name Description
index int
value Instance.Node
Returns
Type Description
Instance.Builder

setNodes(int index, Instance.Node.Builder builderForValue)

public Instance.Builder setNodes(int index, Instance.Node.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue Instance.Node.Builder
Returns
Type Description
Instance.Builder

setObservabilityConfig(Instance.ObservabilityInstanceConfig value)

public Instance.Builder setObservabilityConfig(Instance.ObservabilityInstanceConfig value)

Configuration for observability.

.google.cloud.alloydb.v1beta.Instance.ObservabilityInstanceConfig observability_config = 26;

Parameter
Name Description
value Instance.ObservabilityInstanceConfig
Returns
Type Description
Instance.Builder

setObservabilityConfig(Instance.ObservabilityInstanceConfig.Builder builderForValue)

public Instance.Builder setObservabilityConfig(Instance.ObservabilityInstanceConfig.Builder builderForValue)

Configuration for observability.

.google.cloud.alloydb.v1beta.Instance.ObservabilityInstanceConfig observability_config = 26;

Parameter
Name Description
builderForValue Instance.ObservabilityInstanceConfig.Builder
Returns
Type Description
Instance.Builder

setOutboundPublicIpAddresses(int index, String value)

public Instance.Builder setOutboundPublicIpAddresses(int index, String value)

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
Name Description
index int

The index to set the value at.
value String

The outboundPublicIpAddresses to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setPscInstanceConfig(Instance.PscInstanceConfig value)

public Instance.Builder setPscInstanceConfig(Instance.PscInstanceConfig value)

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

Parameter
Name Description
value Instance.PscInstanceConfig
Returns
Type Description
Instance.Builder

setPscInstanceConfig(Instance.PscInstanceConfig.Builder builderForValue)

public Instance.Builder setPscInstanceConfig(Instance.PscInstanceConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue Instance.PscInstanceConfig.Builder
Returns
Type Description
Instance.Builder

setPublicIpAddress(String value)

public Instance.Builder setPublicIpAddress(String value)

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

Parameter
Name Description
value String

The publicIpAddress to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setPublicIpAddressBytes(ByteString value)

public Instance.Builder setPublicIpAddressBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for publicIpAddress to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setQueryInsightsConfig(Instance.QueryInsightsInstanceConfig value)

public Instance.Builder setQueryInsightsConfig(Instance.QueryInsightsInstanceConfig value)

Configuration for query insights.

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

Parameter
Name Description
value Instance.QueryInsightsInstanceConfig
Returns
Type Description
Instance.Builder

setQueryInsightsConfig(Instance.QueryInsightsInstanceConfig.Builder builderForValue)

public Instance.Builder setQueryInsightsConfig(Instance.QueryInsightsInstanceConfig.Builder builderForValue)

Configuration for query insights.

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

Parameter
Name Description
builderForValue Instance.QueryInsightsInstanceConfig.Builder
Returns
Type Description
Instance.Builder

setReadPoolConfig(Instance.ReadPoolConfig value)

public Instance.Builder setReadPoolConfig(Instance.ReadPoolConfig value)

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;

Parameter
Name Description
value Instance.ReadPoolConfig
Returns
Type Description
Instance.Builder

setReadPoolConfig(Instance.ReadPoolConfig.Builder builderForValue)

public Instance.Builder setReadPoolConfig(Instance.ReadPoolConfig.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Instance.ReadPoolConfig.Builder
Returns
Type Description
Instance.Builder

setReconciling(boolean value)

public Instance.Builder setReconciling(boolean value)

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

Parameter
Name Description
value boolean

The reconciling to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Instance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Instance.Builder
Overrides

setSatisfiesPzs(boolean value)

public Instance.Builder setSatisfiesPzs(boolean value)

Output only. Reserved for future use.

bool satisfies_pzs = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzs to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setState(Instance.State value)

public Instance.Builder setState(Instance.State value)

Output only. The current serving state of the instance.

.google.cloud.alloydb.v1beta.Instance.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Instance.State

The state to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setStateValue(int value)

public Instance.Builder setStateValue(int value)

Output only. The current serving state of the instance.

.google.cloud.alloydb.v1beta.Instance.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setUid(String value)

public Instance.Builder setUid(String value)

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

Parameter
Name Description
value String

The uid to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setUidBytes(ByteString value)

public Instance.Builder setUidBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for uid to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Instance.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Instance.Builder
Overrides

setUpdatePolicy(Instance.UpdatePolicy value)

public Instance.Builder setUpdatePolicy(Instance.UpdatePolicy value)

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;

Parameter
Name Description
value Instance.UpdatePolicy
Returns
Type Description
Instance.Builder

setUpdatePolicy(Instance.UpdatePolicy.Builder builderForValue)

public Instance.Builder setUpdatePolicy(Instance.UpdatePolicy.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Instance.UpdatePolicy.Builder
Returns
Type Description
Instance.Builder

setUpdateTime(Timestamp value)

public Instance.Builder setUpdateTime(Timestamp value)

Output only. Update time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Instance.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Instance.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Update time stamp

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Instance.Builder

setWritableNode(Instance.Node value)

public Instance.Builder setWritableNode(Instance.Node value)

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

Parameter
Name Description
value Instance.Node
Returns
Type Description
Instance.Builder

setWritableNode(Instance.Node.Builder builderForValue)

public Instance.Builder setWritableNode(Instance.Node.Builder builderForValue)

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

Parameter
Name Description
builderForValue Instance.Node.Builder
Returns
Type Description
Instance.Builder