/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/alloydb/v1alpha/resources.proto
package com.google.cloud.alloydb.v1alpha;
public interface InstanceOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.alloydb.v1alpha.Instance)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
* @return The name.
*/
java.lang.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];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* User-settable and human-readable display name for the Instance.
*
*
* string display_name = 2;
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* User-settable and human-readable display name for the Instance.
*
*
* string display_name = 2;
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* 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];
*
* @return The uid.
*/
java.lang.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];
*
* @return The bytes for uid.
*/
com.google.protobuf.ByteString getUidBytes();
/**
*
*
*
* Output only. Create time stamp
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Create time stamp
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. Create time stamp
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. Update time stamp
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. Update time stamp
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. Update time stamp
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Output only. Delete time stamp
*
*
* .google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the deleteTime field is set.
*/
boolean hasDeleteTime();
/**
*
*
*
* Output only. Delete time stamp
*
*
* .google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The deleteTime.
*/
com.google.protobuf.Timestamp getDeleteTime();
/**
*
*
*
* Output only. Delete time stamp
*
*
* .google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder();
/**
*
*
*
* Labels as key value pairs
*
*
* map<string, string> labels = 7;
*/
int getLabelsCount();
/**
*
*
*
* Labels as key value pairs
*
*
* map<string, string> labels = 7;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Labels as key value pairs
*
*
* map<string, string> labels = 7;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Labels as key value pairs
*
*
* map<string, string> labels = 7;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Labels as key value pairs
*
*
* map<string, string> labels = 7;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Output only. The current serving state of the instance.
*
*
*
* .google.cloud.alloydb.v1alpha.Instance.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
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];
*
*
* @return The state.
*/
com.google.cloud.alloydb.v1alpha.Instance.State getState();
/**
*
*
*
* Required. The type of the instance. Specified at creation time.
*
*
*
* .google.cloud.alloydb.v1alpha.Instance.InstanceType instance_type = 9 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The enum numeric value on the wire for instanceType.
*/
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];
*
*
* @return The instanceType.
*/
com.google.cloud.alloydb.v1alpha.Instance.InstanceType getInstanceType();
/**
*
*
*
* Configurations for the machines that host the underlying
* database engine.
*
*
* .google.cloud.alloydb.v1alpha.Instance.MachineConfig machine_config = 10;
*
* @return Whether the machineConfig field is set.
*/
boolean hasMachineConfig();
/**
*
*
*
* Configurations for the machines that host the underlying
* database engine.
*
*
* .google.cloud.alloydb.v1alpha.Instance.MachineConfig machine_config = 10;
*
* @return The machineConfig.
*/
com.google.cloud.alloydb.v1alpha.Instance.MachineConfig getMachineConfig();
/**
*
*
*
* Configurations for the machines that host the underlying
* database engine.
*
*
* .google.cloud.alloydb.v1alpha.Instance.MachineConfig machine_config = 10;
*/
com.google.cloud.alloydb.v1alpha.Instance.MachineConfigOrBuilder getMachineConfigOrBuilder();
/**
*
*
*
* Availability type of an Instance.
* Defaults to REGIONAL for both primary and read instances.
* Note that primary and read instances can have different availability types.
*
*
* .google.cloud.alloydb.v1alpha.Instance.AvailabilityType availability_type = 11;
*
* @return The enum numeric value on the wire for availabilityType.
*/
int getAvailabilityTypeValue();
/**
*
*
*
* Availability type of an Instance.
* Defaults to REGIONAL for both primary and read instances.
* Note that primary and read instances can have different availability types.
*
*
* .google.cloud.alloydb.v1alpha.Instance.AvailabilityType availability_type = 11;
*
* @return The availabilityType.
*/
com.google.cloud.alloydb.v1alpha.Instance.AvailabilityType getAvailabilityType();
/**
*
*
*
* 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;
*
* @return The gceZone.
*/
java.lang.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;
*
* @return The bytes for gceZone.
*/
com.google.protobuf.ByteString getGceZoneBytes();
/**
*
*
*
* 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;
*/
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;
*/
boolean containsDatabaseFlags(java.lang.String key);
/** Use {@link #getDatabaseFlagsMap()} instead. */
@java.lang.Deprecated
java.util.Map getDatabaseFlags();
/**
*
*
*
* 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;
*/
java.util.Map 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;
*/
/* nullable */
java.lang.String getDatabaseFlagsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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;
*/
java.lang.String getDatabaseFlagsOrThrow(java.lang.String key);
/**
*
*
*
* 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];
*
*
* @return Whether the writableNode field is set.
*/
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];
*
*
* @return The writableNode.
*/
com.google.cloud.alloydb.v1alpha.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];
*
*/
com.google.cloud.alloydb.v1alpha.Instance.NodeOrBuilder getWritableNodeOrBuilder();
/**
*
*
*
* 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];
*
*/
java.util.List 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];
*
*/
com.google.cloud.alloydb.v1alpha.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.alloydb.v1alpha.Instance.NodeOrBuilder getNodesOrBuilder(int index);
/**
*
*
*
* Configuration for query insights.
*
*
*
* .google.cloud.alloydb.v1alpha.Instance.QueryInsightsInstanceConfig query_insights_config = 21;
*
*
* @return Whether the queryInsightsConfig field is set.
*/
boolean hasQueryInsightsConfig();
/**
*
*
*
* Configuration for query insights.
*
*
*
* .google.cloud.alloydb.v1alpha.Instance.QueryInsightsInstanceConfig query_insights_config = 21;
*
*
* @return The queryInsightsConfig.
*/
com.google.cloud.alloydb.v1alpha.Instance.QueryInsightsInstanceConfig getQueryInsightsConfig();
/**
*
*
*
* Configuration for query insights.
*
*
*
* .google.cloud.alloydb.v1alpha.Instance.QueryInsightsInstanceConfig query_insights_config = 21;
*
*/
com.google.cloud.alloydb.v1alpha.Instance.QueryInsightsInstanceConfigOrBuilder
getQueryInsightsConfigOrBuilder();
/**
*
*
*
* Read pool specific config.
*
*
* .google.cloud.alloydb.v1alpha.Instance.ReadPoolConfig read_pool_config = 14;
*
* @return Whether the readPoolConfig field is set.
*/
boolean hasReadPoolConfig();
/**
*
*
*
* Read pool specific config.
*
*
* .google.cloud.alloydb.v1alpha.Instance.ReadPoolConfig read_pool_config = 14;
*
* @return The readPoolConfig.
*/
com.google.cloud.alloydb.v1alpha.Instance.ReadPoolConfig getReadPoolConfig();
/**
*
*
*
* Read pool specific config.
*
*
* .google.cloud.alloydb.v1alpha.Instance.ReadPoolConfig read_pool_config = 14;
*/
com.google.cloud.alloydb.v1alpha.Instance.ReadPoolConfigOrBuilder getReadPoolConfigOrBuilder();
/**
*
*
*
* 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];
*
* @return The ipAddress.
*/
java.lang.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];
*
* @return The bytes for ipAddress.
*/
com.google.protobuf.ByteString getIpAddressBytes();
/**
*
*
*
* 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];
*
* @return The reconciling.
*/
boolean getReconciling();
/**
*
*
*
* For Resource freshness validation (https://google.aip.dev/154)
*
*
* string etag = 17;
*
* @return The etag.
*/
java.lang.String getEtag();
/**
*
*
*
* For Resource freshness validation (https://google.aip.dev/154)
*
*
* string etag = 17;
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
/**
*
*
*
* 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;
*/
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;
*/
boolean containsAnnotations(java.lang.String key);
/** Use {@link #getAnnotationsMap()} instead. */
@java.lang.Deprecated
java.util.Map getAnnotations();
/**
*
*
*
* 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;
*/
java.util.Map 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;
*/
/* nullable */
java.lang.String getAnnotationsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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;
*/
java.lang.String getAnnotationsOrThrow(java.lang.String key);
}