Interface InstanceOrBuilder (0.18.0) 

public interface InstanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract 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 abstract 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 abstract boolean containsLabels(String key)

Labels as key value pairs

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations()

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

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

getClientConnectionConfigOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract Map<String,String> getDatabaseFlags()

Use #getDatabaseFlagsMap() instead.

Returns
Type Description
Map<String,String>

getDatabaseFlagsCount()

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

getDeleteTime()

public abstract 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 abstract 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 abstract String getDisplayName()

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

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract 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 abstract String getEtag()

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

string etag = 17;

Returns
Type Description
String

The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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

string etag = 17;

Returns
Type Description
ByteString

The bytes for etag.

getGceZone()

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

getInstanceType()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels as key value pairs

map<string, string> labels = 7;

Returns
Type Description
int

getLabelsMap()

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

getMachineConfigOrBuilder()

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

getName()

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

getNodesCount()

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

getQueryInsightsConfig()

public abstract Instance.QueryInsightsInstanceConfig getQueryInsightsConfig()

Configuration for query insights.

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

Returns
Type Description
Instance.QueryInsightsInstanceConfig

The queryInsightsConfig.

getQueryInsightsConfigOrBuilder()

public abstract Instance.QueryInsightsInstanceConfigOrBuilder getQueryInsightsConfigOrBuilder()

Configuration for query insights.

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

Returns
Type Description
Instance.QueryInsightsInstanceConfigOrBuilder

getReadPoolConfig()

public abstract Instance.ReadPoolConfig getReadPoolConfig()

Read pool specific config.

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

Returns
Type Description
Instance.ReadPoolConfig

The readPoolConfig.

getReadPoolConfigOrBuilder()

public abstract Instance.ReadPoolConfigOrBuilder getReadPoolConfigOrBuilder()

Read pool specific config.

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

Returns
Type Description
Instance.ReadPoolConfigOrBuilder

getReconciling()

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

getState()

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

getUpdatePolicyOrBuilder()

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

getWritableNodeOrBuilder()

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

hasQueryInsightsConfig()

public abstract 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 abstract boolean hasReadPoolConfig()

Read pool specific config.

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

Returns
Type Description
boolean

Whether the readPoolConfig field is set.

hasUpdatePolicy()

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