Package com.google.cloud.alloydb.v1

Interface InstanceOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Instance, Instance.Builder
    public interface InstanceOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Output only. The name of the instance resource with the format:
  * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id}
 where the cluster and instance ID segments should satisfy the regex
 expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of
 lowercase letters, numbers, and dashes, starting with a letter, and ending
 with a letter or number. For more details see https://google.aip.dev/122.
 The prefix of the instance resource name is the name of the parent
 resource:
  * projects/{project}/locations/{region}/clusters/{cluster_id}
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Output only. The name of the instance resource with the format:
  * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id}
 where the cluster and instance ID segments should satisfy the regex
 expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of
 lowercase letters, numbers, and dashes, starting with a letter, and ending
 with a letter or number. For more details see https://google.aip.dev/122.
 The prefix of the instance resource name is the name of the parent
 resource:
  * projects/{project}/locations/{region}/clusters/{cluster_id}
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for name.

      • getDisplayName

        String getDisplayName()
         User-settable and human-readable display name for the Instance.
        string display_name = 2;
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         User-settable and human-readable display name for the Instance.
        string display_name = 2;
        Returns:
        The bytes for displayName.

      • getUid

        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:
        The uid.

      • getUidBytes

        com.google.protobuf.ByteString getUidBytes()
         Output only. The system-generated UID of the resource. The UID is assigned
 when the resource is created, and it is retained until it is deleted.
        string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for uid.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Create time stamp
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. Create time stamp
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

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

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. Update time stamp
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        com.google.protobuf.Timestamp getUpdateTime()
         Output only. Update time stamp
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

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

      • hasDeleteTime

        boolean hasDeleteTime()
         Output only. Delete time stamp
        .google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the deleteTime field is set.

      • getDeleteTime

        com.google.protobuf.Timestamp getDeleteTime()
         Output only. Delete time stamp
        .google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The deleteTime.

      • getDeleteTimeOrBuilder

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

      • getLabelsCount

        int getLabelsCount()
         Labels as key value pairs
        map<string, string> labels = 7;

      • containsLabels

        boolean containsLabels​(String key)
         Labels as key value pairs
        map<string, string> labels = 7;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Labels as key value pairs
        map<string, string> labels = 7;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Labels as key value pairs
        map<string, string> labels = 7;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Labels as key value pairs
        map<string, string> labels = 7;

      • getStateValue

        int getStateValue()
         Output only. The current serving state of the instance.
        .google.cloud.alloydb.v1.Instance.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for state.

      • getState

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

      • getInstanceTypeValue

        int getInstanceTypeValue()
         Required. The type of the instance. Specified at creation time.
        .google.cloud.alloydb.v1.Instance.InstanceType instance_type = 9 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The enum numeric value on the wire for instanceType.

      • getInstanceType

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

      • hasMachineConfig

        boolean hasMachineConfig()
         Configurations for the machines that host the underlying
 database engine.
        .google.cloud.alloydb.v1.Instance.MachineConfig machine_config = 10;
        Returns:
        Whether the machineConfig field is set.

      • getMachineConfig

        Instance.MachineConfig getMachineConfig()
         Configurations for the machines that host the underlying
 database engine.
        .google.cloud.alloydb.v1.Instance.MachineConfig machine_config = 10;
        Returns:
        The machineConfig.

      • getMachineConfigOrBuilder

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

      • getAvailabilityTypeValue

        int getAvailabilityTypeValue()
         Availability type of an Instance.
 If empty, defaults to REGIONAL for primary instances.
 For read pools, availability_type is always UNSPECIFIED. Instances in the
 read pools are evenly distributed across available zones within the region
 (i.e. read pools with more than one node will have a node in at
 least two zones).
        .google.cloud.alloydb.v1.Instance.AvailabilityType availability_type = 11;
        Returns:
        The enum numeric value on the wire for availabilityType.

      • getAvailabilityType

        Instance.AvailabilityType getAvailabilityType()
         Availability type of an Instance.
 If empty, defaults to REGIONAL for primary instances.
 For read pools, availability_type is always UNSPECIFIED. Instances in the
 read pools are evenly distributed across available zones within the region
 (i.e. read pools with more than one node will have a node in at
 least two zones).
        .google.cloud.alloydb.v1.Instance.AvailabilityType availability_type = 11;
        Returns:
        The availabilityType.

      • getGceZone

        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:
        The gceZone.

      • getGceZoneBytes

        com.google.protobuf.ByteString getGceZoneBytes()
         The Compute Engine zone that the instance should serve from, per
 https://cloud.google.com/compute/docs/regions-zones
 This can ONLY be specified for ZONAL instances.
 If present for a REGIONAL instance, an error will be thrown.
 If this is absent for a ZONAL instance, instance is created in a random
 zone with available capacity.
        string gce_zone = 12;
        Returns:
        The bytes for gceZone.

      • getDatabaseFlagsCount

        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;

      • containsDatabaseFlags

        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;

      • getDatabaseFlagsMap

        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;

      • getDatabaseFlagsOrDefault

        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;

      • getDatabaseFlagsOrThrow

        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;

      • hasWritableNode

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

      • getWritableNode

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

      • getWritableNodeOrBuilder

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

      • getNodesList

        List<Instance.Node> getNodesList()
         Output only. List of available read-only VMs in this instance, including
 the standby for a PRIMARY instance.
        repeated .google.cloud.alloydb.v1.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getNodes

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

      • getNodesCount

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

      • getNodesOrBuilderList

        List<? extends Instance.NodeOrBuilder> getNodesOrBuilderList()
         Output only. List of available read-only VMs in this instance, including
 the standby for a PRIMARY instance.
        repeated .google.cloud.alloydb.v1.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getNodesOrBuilder

        Instance.NodeOrBuilder getNodesOrBuilder​(int index)
         Output only. List of available read-only VMs in this instance, including
 the standby for a PRIMARY instance.
        repeated .google.cloud.alloydb.v1.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasQueryInsightsConfig

        boolean hasQueryInsightsConfig()
         Configuration for query insights.
        .google.cloud.alloydb.v1.Instance.QueryInsightsInstanceConfig query_insights_config = 21;
        Returns:
        Whether the queryInsightsConfig field is set.

      • getQueryInsightsConfig

        Instance.QueryInsightsInstanceConfig getQueryInsightsConfig()
         Configuration for query insights.
        .google.cloud.alloydb.v1.Instance.QueryInsightsInstanceConfig query_insights_config = 21;
        Returns:
        The queryInsightsConfig.

      • getQueryInsightsConfigOrBuilder

        Instance.QueryInsightsInstanceConfigOrBuilder getQueryInsightsConfigOrBuilder()
         Configuration for query insights.
        .google.cloud.alloydb.v1.Instance.QueryInsightsInstanceConfig query_insights_config = 21;

      • hasReadPoolConfig

        boolean hasReadPoolConfig()
         Read pool specific config.
        .google.cloud.alloydb.v1.Instance.ReadPoolConfig read_pool_config = 14;
        Returns:
        Whether the readPoolConfig field is set.

      • getReadPoolConfig

        Instance.ReadPoolConfig getReadPoolConfig()
         Read pool specific config.
        .google.cloud.alloydb.v1.Instance.ReadPoolConfig read_pool_config = 14;
        Returns:
        The readPoolConfig.

      • getReadPoolConfigOrBuilder

        Instance.ReadPoolConfigOrBuilder getReadPoolConfigOrBuilder()
         Read pool specific config.
        .google.cloud.alloydb.v1.Instance.ReadPoolConfig read_pool_config = 14;

      • getIpAddress

        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:
        The ipAddress.

      • getIpAddressBytes

        com.google.protobuf.ByteString getIpAddressBytes()
         Output only. The IP address for the Instance.
 This is the connection endpoint for an end-user application.
        string ip_address = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for ipAddress.

      • getReconciling

        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:
        The reconciling.

      • getEtag

        String getEtag()
         For Resource freshness validation (https://google.aip.dev/154)
        string etag = 17;
        Returns:
        The etag.

      • getEtagBytes

        com.google.protobuf.ByteString getEtagBytes()
         For Resource freshness validation (https://google.aip.dev/154)
        string etag = 17;
        Returns:
        The bytes for etag.

      • getAnnotationsCount

        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;

      • containsAnnotations

        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;

      • getAnnotationsMap

        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;

      • getAnnotationsOrDefault

        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;

      • getAnnotationsOrThrow

        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;