Class Instance (0.23.0)

public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder

An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.

Protobuf type google.cloud.alloydb.v1alpha.Instance

Implements

InstanceOrBuilder

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

AVAILABILITY_TYPE_FIELD_NUMBER

public static final int AVAILABILITY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

CLIENT_CONNECTION_CONFIG_FIELD_NUMBER

public static final int CLIENT_CONNECTION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_FLAGS_FIELD_NUMBER

public static final int DATABASE_FLAGS_FIELD_NUMBER
Field Value
Type Description
int

DELETE_TIME_FIELD_NUMBER

public static final int DELETE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

GCE_ZONE_FIELD_NUMBER

public static final int GCE_ZONE_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_TYPE_FIELD_NUMBER

public static final int INSTANCE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

IP_ADDRESS_FIELD_NUMBER

public static final int IP_ADDRESS_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MACHINE_CONFIG_FIELD_NUMBER

public static final int MACHINE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_CONFIG_FIELD_NUMBER

public static final int NETWORK_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NODES_FIELD_NUMBER

public static final int NODES_FIELD_NUMBER
Field Value
Type Description
int

PSC_INSTANCE_CONFIG_FIELD_NUMBER

public static final int PSC_INSTANCE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

QUERY_INSIGHTS_CONFIG_FIELD_NUMBER

public static final int QUERY_INSIGHTS_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

READ_POOL_CONFIG_FIELD_NUMBER

public static final int READ_POOL_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

RECONCILING_FIELD_NUMBER

public static final int RECONCILING_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_POLICY_FIELD_NUMBER

public static final int UPDATE_POLICY_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

WRITABLE_NODE_FIELD_NUMBER

public static final int WRITABLE_NODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Instance getDefaultInstance()
Returns
Type Description
Instance

getDescriptor()

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

newBuilder()

public static Instance.Builder newBuilder()
Returns
Type Description
Instance.Builder

newBuilder(Instance prototype)

public static Instance.Builder newBuilder(Instance prototype)
Parameter
Name Description
prototype Instance
Returns
Type Description
Instance.Builder

parseDelimitedFrom(InputStream input)

public static Instance parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Instance parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Instance parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Instance parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Instance parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Instance parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Instance> parser()
Returns
Type Description
Parser<Instance>

Methods

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 18;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsDatabaseFlags(String key)

public boolean containsDatabaseFlags(String key)

Database flags. Set at instance level.

  • They are copied from primary instance on read instance creation.
  • Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary.

This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.

map<string, string> database_flags = 13;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Labels as key value pairs

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.v1alpha.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.v1alpha.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.v1alpha.Instance.ClientConnectionConfig client_connection_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.ClientConnectionConfig

The clientConnectionConfig.

getClientConnectionConfigOrBuilder()

public Instance.ClientConnectionConfigOrBuilder getClientConnectionConfigOrBuilder()

Optional. Client connection specific configurations

.google.cloud.alloydb.v1alpha.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.

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()
Returns
Type Description
Map<String,String>

getDatabaseFlagsCount()

public int getDatabaseFlagsCount()

Database flags. Set at instance level.

  • They are copied from primary instance on read instance creation.
  • Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary.

This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.

map<string, string> database_flags = 13;

Returns
Type Description
int

getDatabaseFlagsMap()

public Map<String,String> getDatabaseFlagsMap()

Database flags. Set at instance level.

  • They are copied from primary instance on read instance creation.
  • Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary.

This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.

map<string, string> database_flags = 13;

Returns
Type Description
Map<String,String>

getDatabaseFlagsOrDefault(String key, String defaultValue)

public String getDatabaseFlagsOrDefault(String key, String defaultValue)

Database flags. Set at instance level.

  • They are copied from primary instance on read instance creation.
  • Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary.

This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.

map<string, string> database_flags = 13;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getDatabaseFlagsOrThrow(String key)

public String getDatabaseFlagsOrThrow(String key)

Database flags. Set at instance level.

  • They are copied from primary instance on read instance creation.
  • Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary.

This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.

map<string, string> database_flags = 13;

Parameter
Name Description
key String
Returns
Type Description
String

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()
Returns
Type Description
Instance

getDeleteTime()

public Timestamp getDeleteTime()

Output only. Delete time stamp

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

Returns
Type Description
Timestamp

The deleteTime.

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. Delete time stamp

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

Returns
Type Description
TimestampOrBuilder

getDisplayName()

public String getDisplayName()

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

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

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

string etag = 17;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

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

string etag = 17;

Returns
Type Description
ByteString

The bytes for etag.

getGceZone()

public String getGceZone()

The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.

string gce_zone = 12;

Returns
Type Description
String

The gceZone.

getGceZoneBytes()

public ByteString getGceZoneBytes()

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 Instance.InstanceType getInstanceType()

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

.google.cloud.alloydb.v1alpha.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.v1alpha.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.v1alpha.Instance.MachineConfig machine_config = 10;

Returns
Type Description
Instance.MachineConfig

The machineConfig.

getMachineConfigOrBuilder()

public Instance.MachineConfigOrBuilder getMachineConfigOrBuilder()

Configurations for the machines that host the underlying database engine.

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

Returns
Type Description
Instance.MachineConfigOrBuilder

getName()

public String getName()

Output only. The name of the instance resource with the format:

  • projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression a-z?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource:
  • projects/{project}/locations/{region}/clusters/{cluster_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The name of the instance resource with the format:

  • projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression a-z?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource:
  • projects/{project}/locations/{region}/clusters/{cluster_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getNetworkConfig()

public Instance.InstanceNetworkConfig getNetworkConfig()

Optional. Instance level network configuration.

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

Returns
Type Description
Instance.InstanceNetworkConfig

The networkConfig.

getNetworkConfigOrBuilder()

public Instance.InstanceNetworkConfigOrBuilder getNetworkConfigOrBuilder()

Optional. Instance level network configuration.

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

Parameter
Name Description
index int
Returns
Type Description
Instance.Node

getNodesCount()

public int getNodesCount()

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

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

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

getParserForType()

public Parser<Instance> getParserForType()
Returns
Type Description
Parser<Instance>
Overrides

getPscInstanceConfig()

public Instance.PscInstanceConfig getPscInstanceConfig()

Optional. The configuration for Private Service Connect (PSC) for the instance.

.google.cloud.alloydb.v1alpha.Instance.PscInstanceConfig psc_instance_config = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.PscInstanceConfig

The pscInstanceConfig.

getPscInstanceConfigOrBuilder()

public Instance.PscInstanceConfigOrBuilder getPscInstanceConfigOrBuilder()

Optional. The configuration for Private Service Connect (PSC) for the instance.

.google.cloud.alloydb.v1alpha.Instance.PscInstanceConfig psc_instance_config = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.PscInstanceConfigOrBuilder

getQueryInsightsConfig()

public Instance.QueryInsightsInstanceConfig getQueryInsightsConfig()

Configuration for query insights.

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

Returns
Type Description
Instance.QueryInsightsInstanceConfig

The queryInsightsConfig.

getQueryInsightsConfigOrBuilder()

public Instance.QueryInsightsInstanceConfigOrBuilder getQueryInsightsConfigOrBuilder()

Configuration for query insights.

.google.cloud.alloydb.v1alpha.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.v1alpha.Instance.ReadPoolConfig read_pool_config = 14;

Returns
Type Description
Instance.ReadPoolConfig

The readPoolConfig.

getReadPoolConfigOrBuilder()

public Instance.ReadPoolConfigOrBuilder getReadPoolConfigOrBuilder()

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

.google.cloud.alloydb.v1alpha.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.

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzi.

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Instance.State getState()

Output only. The current serving state of the instance.

.google.cloud.alloydb.v1alpha.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.v1alpha.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.v1alpha.Instance.UpdatePolicy update_policy = 22;

Returns
Type Description
Instance.UpdatePolicy

The updatePolicy.

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

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

Returns
Type Description
Instance.Node

The writableNode.

getWritableNodeOrBuilder()

public Instance.NodeOrBuilder getWritableNodeOrBuilder()

Output only. This is set for the read-write VM of the PRIMARY instance only.

.google.cloud.alloydb.v1alpha.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.v1alpha.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.

hasMachineConfig()

public boolean hasMachineConfig()

Configurations for the machines that host the underlying database engine.

.google.cloud.alloydb.v1alpha.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.v1alpha.Instance.InstanceNetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the networkConfig field is set.

hasPscInstanceConfig()

public boolean hasPscInstanceConfig()

Optional. The configuration for Private Service Connect (PSC) for the instance.

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

Returns
Type Description
boolean

Whether the writableNode field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Instance.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException