Package com.google.cloud.alloydb.v1beta
Class Instance
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.alloydb.v1beta.Instance
-
- All Implemented Interfaces:
InstanceOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class Instance extends com.google.protobuf.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 typegoogle.cloud.alloydb.v1beta.Instance
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Instance.AvailabilityType
The Availability type of an instance.static class
Instance.Builder
An Instance is a computing unit that an end customer can connect to.static class
Instance.InstanceType
Type of an Instancestatic class
Instance.MachineConfig
MachineConfig describes the configuration of a machine.static interface
Instance.MachineConfigOrBuilder
static class
Instance.Node
Details of a single node in the instance.static interface
Instance.NodeOrBuilder
static class
Instance.QueryInsightsInstanceConfig
QueryInsights Instance specific configuration.static interface
Instance.QueryInsightsInstanceConfigOrBuilder
static class
Instance.ReadPoolConfig
Configuration for a read pool instance.static interface
Instance.ReadPoolConfigOrBuilder
static class
Instance.State
Instance Statestatic class
Instance.UpdatePolicy
Policy to be used while updating the instance.static interface
Instance.UpdatePolicyOrBuilder
-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
ANNOTATIONS_FIELD_NUMBER
static int
AVAILABILITY_TYPE_FIELD_NUMBER
static int
CREATE_TIME_FIELD_NUMBER
static int
DATABASE_FLAGS_FIELD_NUMBER
static int
DELETE_TIME_FIELD_NUMBER
static int
DISPLAY_NAME_FIELD_NUMBER
static int
ETAG_FIELD_NUMBER
static int
GCE_ZONE_FIELD_NUMBER
static int
INSTANCE_TYPE_FIELD_NUMBER
static int
IP_ADDRESS_FIELD_NUMBER
static int
LABELS_FIELD_NUMBER
static int
MACHINE_CONFIG_FIELD_NUMBER
static int
NAME_FIELD_NUMBER
static int
NODES_FIELD_NUMBER
static int
QUERY_INSIGHTS_CONFIG_FIELD_NUMBER
static int
READ_POOL_CONFIG_FIELD_NUMBER
static int
RECONCILING_FIELD_NUMBER
static int
STATE_FIELD_NUMBER
static int
UID_FIELD_NUMBER
static int
UPDATE_POLICY_FIELD_NUMBER
static int
UPDATE_TIME_FIELD_NUMBER
static int
WRITABLE_NODE_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
containsAnnotations(String key)
Annotations to allow client tools to store small amount of arbitrary data.boolean
containsDatabaseFlags(String key)
Database flags.boolean
containsLabels(String key)
Labels as key value pairsboolean
equals(Object obj)
Map<String,String>
getAnnotations()
Deprecated.int
getAnnotationsCount()
Annotations to allow client tools to store small amount of arbitrary data.Map<String,String>
getAnnotationsMap()
Annotations to allow client tools to store small amount of arbitrary data.String
getAnnotationsOrDefault(String key, String defaultValue)
Annotations to allow client tools to store small amount of arbitrary data.String
getAnnotationsOrThrow(String key)
Annotations to allow client tools to store small amount of arbitrary data.Instance.AvailabilityType
getAvailabilityType()
Availability type of an Instance.int
getAvailabilityTypeValue()
Availability type of an Instance.com.google.protobuf.Timestamp
getCreateTime()
Output only.com.google.protobuf.TimestampOrBuilder
getCreateTimeOrBuilder()
Output only.Map<String,String>
getDatabaseFlags()
Deprecated.int
getDatabaseFlagsCount()
Database flags.Map<String,String>
getDatabaseFlagsMap()
Database flags.String
getDatabaseFlagsOrDefault(String key, String defaultValue)
Database flags.String
getDatabaseFlagsOrThrow(String key)
Database flags.static Instance
getDefaultInstance()
Instance
getDefaultInstanceForType()
com.google.protobuf.Timestamp
getDeleteTime()
Output only.com.google.protobuf.TimestampOrBuilder
getDeleteTimeOrBuilder()
Output only.static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
String
getDisplayName()
User-settable and human-readable display name for the Instance.com.google.protobuf.ByteString
getDisplayNameBytes()
User-settable and human-readable display name for the Instance.String
getEtag()
For Resource freshness validation (https://google.aip.dev/154)com.google.protobuf.ByteString
getEtagBytes()
For Resource freshness validation (https://google.aip.dev/154)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.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.Instance.InstanceType
getInstanceType()
Required.int
getInstanceTypeValue()
Required.String
getIpAddress()
Output only.com.google.protobuf.ByteString
getIpAddressBytes()
Output only.Map<String,String>
getLabels()
Deprecated.int
getLabelsCount()
Labels as key value pairsMap<String,String>
getLabelsMap()
Labels as key value pairsString
getLabelsOrDefault(String key, String defaultValue)
Labels as key value pairsString
getLabelsOrThrow(String key)
Labels as key value pairsInstance.MachineConfig
getMachineConfig()
Configurations for the machines that host the underlying database engine.Instance.MachineConfigOrBuilder
getMachineConfigOrBuilder()
Configurations for the machines that host the underlying database engine.String
getName()
Output only.com.google.protobuf.ByteString
getNameBytes()
Output only.Instance.Node
getNodes(int index)
Output only.int
getNodesCount()
Output only.List<Instance.Node>
getNodesList()
Output only.Instance.NodeOrBuilder
getNodesOrBuilder(int index)
Output only.List<? extends Instance.NodeOrBuilder>
getNodesOrBuilderList()
Output only.com.google.protobuf.Parser<Instance>
getParserForType()
Instance.QueryInsightsInstanceConfig
getQueryInsightsConfig()
Configuration for query insights.Instance.QueryInsightsInstanceConfigOrBuilder
getQueryInsightsConfigOrBuilder()
Configuration for query insights.Instance.ReadPoolConfig
getReadPoolConfig()
Read pool specific config.Instance.ReadPoolConfigOrBuilder
getReadPoolConfigOrBuilder()
Read pool specific config.boolean
getReconciling()
Output only.int
getSerializedSize()
Instance.State
getState()
Output only.int
getStateValue()
Output only.String
getUid()
Output only.com.google.protobuf.ByteString
getUidBytes()
Output only.Instance.UpdatePolicy
getUpdatePolicy()
Update policy that will be applied during instance update.Instance.UpdatePolicyOrBuilder
getUpdatePolicyOrBuilder()
Update policy that will be applied during instance update.com.google.protobuf.Timestamp
getUpdateTime()
Output only.com.google.protobuf.TimestampOrBuilder
getUpdateTimeOrBuilder()
Output only.Instance.Node
getWritableNode()
Output only.Instance.NodeOrBuilder
getWritableNodeOrBuilder()
Output only.boolean
hasCreateTime()
Output only.boolean
hasDeleteTime()
Output only.int
hashCode()
boolean
hasMachineConfig()
Configurations for the machines that host the underlying database engine.boolean
hasQueryInsightsConfig()
Configuration for query insights.boolean
hasReadPoolConfig()
Read pool specific config.boolean
hasUpdatePolicy()
Update policy that will be applied during instance update.boolean
hasUpdateTime()
Output only.boolean
hasWritableNode()
Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapField
internalGetMapField(int number)
boolean
isInitialized()
static Instance.Builder
newBuilder()
static Instance.Builder
newBuilder(Instance prototype)
Instance.Builder
newBuilderForType()
protected Instance.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Instance
parseDelimitedFrom(InputStream input)
static Instance
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Instance
parseFrom(byte[] data)
static Instance
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Instance
parseFrom(com.google.protobuf.ByteString data)
static Instance
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Instance
parseFrom(com.google.protobuf.CodedInputStream input)
static Instance
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Instance
parseFrom(InputStream input)
static Instance
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Instance
parseFrom(ByteBuffer data)
static Instance
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Instance>
parser()
Instance.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
INSTANCE_TYPE_FIELD_NUMBER
public static final int INSTANCE_TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MACHINE_CONFIG_FIELD_NUMBER
public static final int MACHINE_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
AVAILABILITY_TYPE_FIELD_NUMBER
public static final int AVAILABILITY_TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
GCE_ZONE_FIELD_NUMBER
public static final int GCE_ZONE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DATABASE_FLAGS_FIELD_NUMBER
public static final int DATABASE_FLAGS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
WRITABLE_NODE_FIELD_NUMBER
public static final int WRITABLE_NODE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
NODES_FIELD_NUMBER
public static final int NODES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
QUERY_INSIGHTS_CONFIG_FIELD_NUMBER
public static final int QUERY_INSIGHTS_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
READ_POOL_CONFIG_FIELD_NUMBER
public static final int READ_POOL_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
IP_ADDRESS_FIELD_NUMBER
public static final int IP_ADDRESS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
UPDATE_POLICY_FIELD_NUMBER
public static final int UPDATE_POLICY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
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]([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];
- Specified by:
getName
in interfaceInstanceOrBuilder
- Returns:
- The name.
-
getNameBytes
public 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];
- Specified by:
getNameBytes
in interfaceInstanceOrBuilder
- Returns:
- The bytes for name.
-
getDisplayName
public String getDisplayName()
User-settable and human-readable display name for the Instance.
string display_name = 2;
- Specified by:
getDisplayName
in interfaceInstanceOrBuilder
- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.ByteString getDisplayNameBytes()
User-settable and human-readable display name for the Instance.
string display_name = 2;
- Specified by:
getDisplayNameBytes
in interfaceInstanceOrBuilder
- Returns:
- The bytes for displayName.
-
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];
- Specified by:
getUid
in interfaceInstanceOrBuilder
- Returns:
- The uid.
-
getUidBytes
public 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];
- Specified by:
getUidBytes
in interfaceInstanceOrBuilder
- Returns:
- The bytes for uid.
-
hasCreateTime
public boolean hasCreateTime()
Output only. Create time stamp
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasCreateTime
in interfaceInstanceOrBuilder
- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()
Output only. Create time stamp
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getCreateTime
in interfaceInstanceOrBuilder
- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Create time stamp
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getCreateTimeOrBuilder
in interfaceInstanceOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()
Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasUpdateTime
in interfaceInstanceOrBuilder
- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()
Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getUpdateTime
in interfaceInstanceOrBuilder
- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getUpdateTimeOrBuilder
in interfaceInstanceOrBuilder
-
hasDeleteTime
public boolean hasDeleteTime()
Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasDeleteTime
in interfaceInstanceOrBuilder
- Returns:
- Whether the deleteTime field is set.
-
getDeleteTime
public com.google.protobuf.Timestamp getDeleteTime()
Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getDeleteTime
in interfaceInstanceOrBuilder
- Returns:
- The deleteTime.
-
getDeleteTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getDeleteTimeOrBuilder
in interfaceInstanceOrBuilder
-
getLabelsCount
public int getLabelsCount()
Description copied from interface:InstanceOrBuilder
Labels as key value pairs
map<string, string> labels = 7;
- Specified by:
getLabelsCount
in interfaceInstanceOrBuilder
-
containsLabels
public boolean containsLabels(String key)
Labels as key value pairs
map<string, string> labels = 7;
- Specified by:
containsLabels
in interfaceInstanceOrBuilder
-
getLabels
@Deprecated public Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()
instead.- Specified by:
getLabels
in interfaceInstanceOrBuilder
-
getLabelsMap
public Map<String,String> getLabelsMap()
Labels as key value pairs
map<string, string> labels = 7;
- Specified by:
getLabelsMap
in interfaceInstanceOrBuilder
-
getLabelsOrDefault
public String getLabelsOrDefault(String key, String defaultValue)
Labels as key value pairs
map<string, string> labels = 7;
- Specified by:
getLabelsOrDefault
in interfaceInstanceOrBuilder
-
getLabelsOrThrow
public String getLabelsOrThrow(String key)
Labels as key value pairs
map<string, string> labels = 7;
- Specified by:
getLabelsOrThrow
in interfaceInstanceOrBuilder
-
getStateValue
public int getStateValue()
Output only. The current serving state of the instance.
.google.cloud.alloydb.v1beta.Instance.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getStateValue
in interfaceInstanceOrBuilder
- Returns:
- The enum numeric value on the wire for state.
-
getState
public Instance.State getState()
Output only. The current serving state of the instance.
.google.cloud.alloydb.v1beta.Instance.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getState
in interfaceInstanceOrBuilder
- Returns:
- The state.
-
getInstanceTypeValue
public int getInstanceTypeValue()
Required. The type of the instance. Specified at creation time.
.google.cloud.alloydb.v1beta.Instance.InstanceType instance_type = 9 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getInstanceTypeValue
in interfaceInstanceOrBuilder
- Returns:
- The enum numeric value on the wire for instanceType.
-
getInstanceType
public Instance.InstanceType getInstanceType()
Required. The type of the instance. Specified at creation time.
.google.cloud.alloydb.v1beta.Instance.InstanceType instance_type = 9 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getInstanceType
in interfaceInstanceOrBuilder
- Returns:
- The instanceType.
-
hasMachineConfig
public boolean hasMachineConfig()
Configurations for the machines that host the underlying database engine.
.google.cloud.alloydb.v1beta.Instance.MachineConfig machine_config = 10;
- Specified by:
hasMachineConfig
in interfaceInstanceOrBuilder
- Returns:
- Whether the machineConfig field is set.
-
getMachineConfig
public Instance.MachineConfig getMachineConfig()
Configurations for the machines that host the underlying database engine.
.google.cloud.alloydb.v1beta.Instance.MachineConfig machine_config = 10;
- Specified by:
getMachineConfig
in interfaceInstanceOrBuilder
- Returns:
- The machineConfig.
-
getMachineConfigOrBuilder
public Instance.MachineConfigOrBuilder getMachineConfigOrBuilder()
Configurations for the machines that host the underlying database engine.
.google.cloud.alloydb.v1beta.Instance.MachineConfig machine_config = 10;
- Specified by:
getMachineConfigOrBuilder
in interfaceInstanceOrBuilder
-
getAvailabilityTypeValue
public int getAvailabilityTypeValue()
Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
.google.cloud.alloydb.v1beta.Instance.AvailabilityType availability_type = 11;
- Specified by:
getAvailabilityTypeValue
in interfaceInstanceOrBuilder
- Returns:
- The enum numeric value on the wire for availabilityType.
-
getAvailabilityType
public Instance.AvailabilityType getAvailabilityType()
Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
.google.cloud.alloydb.v1beta.Instance.AvailabilityType availability_type = 11;
- Specified by:
getAvailabilityType
in interfaceInstanceOrBuilder
- Returns:
- The availabilityType.
-
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;
- Specified by:
getGceZone
in interfaceInstanceOrBuilder
- Returns:
- The gceZone.
-
getGceZoneBytes
public 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;
- Specified by:
getGceZoneBytes
in interfaceInstanceOrBuilder
- Returns:
- The bytes for gceZone.
-
getDatabaseFlagsCount
public int getDatabaseFlagsCount()
Description copied from interface:InstanceOrBuilder
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;
- Specified by:
getDatabaseFlagsCount
in interfaceInstanceOrBuilder
-
containsDatabaseFlags
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;
- Specified by:
containsDatabaseFlags
in interfaceInstanceOrBuilder
-
getDatabaseFlags
@Deprecated public Map<String,String> getDatabaseFlags()
Deprecated.UsegetDatabaseFlagsMap()
instead.- Specified by:
getDatabaseFlags
in interfaceInstanceOrBuilder
-
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;
- Specified by:
getDatabaseFlagsMap
in interfaceInstanceOrBuilder
-
getDatabaseFlagsOrDefault
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;
- Specified by:
getDatabaseFlagsOrDefault
in interfaceInstanceOrBuilder
-
getDatabaseFlagsOrThrow
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;
- Specified by:
getDatabaseFlagsOrThrow
in interfaceInstanceOrBuilder
-
hasWritableNode
public boolean hasWritableNode()
Output only. This is set for the read-write VM of the PRIMARY instance only.
.google.cloud.alloydb.v1beta.Instance.Node writable_node = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasWritableNode
in interfaceInstanceOrBuilder
- Returns:
- Whether the writableNode field is set.
-
getWritableNode
public Instance.Node getWritableNode()
Output only. This is set for the read-write VM of the PRIMARY instance only.
.google.cloud.alloydb.v1beta.Instance.Node writable_node = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getWritableNode
in interfaceInstanceOrBuilder
- Returns:
- 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.v1beta.Instance.Node writable_node = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getWritableNodeOrBuilder
in interfaceInstanceOrBuilder
-
getNodesList
public List<Instance.Node> getNodesList()
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
repeated .google.cloud.alloydb.v1beta.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getNodesList
in interfaceInstanceOrBuilder
-
getNodesOrBuilderList
public List<? extends Instance.NodeOrBuilder> getNodesOrBuilderList()
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
repeated .google.cloud.alloydb.v1beta.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getNodesOrBuilderList
in interfaceInstanceOrBuilder
-
getNodesCount
public int getNodesCount()
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
repeated .google.cloud.alloydb.v1beta.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getNodesCount
in interfaceInstanceOrBuilder
-
getNodes
public Instance.Node getNodes(int index)
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
repeated .google.cloud.alloydb.v1beta.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getNodes
in interfaceInstanceOrBuilder
-
getNodesOrBuilder
public Instance.NodeOrBuilder getNodesOrBuilder(int index)
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
repeated .google.cloud.alloydb.v1beta.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getNodesOrBuilder
in interfaceInstanceOrBuilder
-
hasQueryInsightsConfig
public boolean hasQueryInsightsConfig()
Configuration for query insights.
.google.cloud.alloydb.v1beta.Instance.QueryInsightsInstanceConfig query_insights_config = 21;
- Specified by:
hasQueryInsightsConfig
in interfaceInstanceOrBuilder
- Returns:
- Whether the queryInsightsConfig field is set.
-
getQueryInsightsConfig
public Instance.QueryInsightsInstanceConfig getQueryInsightsConfig()
Configuration for query insights.
.google.cloud.alloydb.v1beta.Instance.QueryInsightsInstanceConfig query_insights_config = 21;
- Specified by:
getQueryInsightsConfig
in interfaceInstanceOrBuilder
- Returns:
- The queryInsightsConfig.
-
getQueryInsightsConfigOrBuilder
public Instance.QueryInsightsInstanceConfigOrBuilder getQueryInsightsConfigOrBuilder()
Configuration for query insights.
.google.cloud.alloydb.v1beta.Instance.QueryInsightsInstanceConfig query_insights_config = 21;
- Specified by:
getQueryInsightsConfigOrBuilder
in interfaceInstanceOrBuilder
-
hasReadPoolConfig
public boolean hasReadPoolConfig()
Read pool specific config.
.google.cloud.alloydb.v1beta.Instance.ReadPoolConfig read_pool_config = 14;
- Specified by:
hasReadPoolConfig
in interfaceInstanceOrBuilder
- Returns:
- Whether the readPoolConfig field is set.
-
getReadPoolConfig
public Instance.ReadPoolConfig getReadPoolConfig()
Read pool specific config.
.google.cloud.alloydb.v1beta.Instance.ReadPoolConfig read_pool_config = 14;
- Specified by:
getReadPoolConfig
in interfaceInstanceOrBuilder
- Returns:
- The readPoolConfig.
-
getReadPoolConfigOrBuilder
public Instance.ReadPoolConfigOrBuilder getReadPoolConfigOrBuilder()
Read pool specific config.
.google.cloud.alloydb.v1beta.Instance.ReadPoolConfig read_pool_config = 14;
- Specified by:
getReadPoolConfigOrBuilder
in interfaceInstanceOrBuilder
-
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];
- Specified by:
getIpAddress
in interfaceInstanceOrBuilder
- Returns:
- The ipAddress.
-
getIpAddressBytes
public 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];
- Specified by:
getIpAddressBytes
in interfaceInstanceOrBuilder
- Returns:
- The bytes for ipAddress.
-
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];
- Specified by:
getReconciling
in interfaceInstanceOrBuilder
- Returns:
- The reconciling.
-
getEtag
public String getEtag()
For Resource freshness validation (https://google.aip.dev/154)
string etag = 17;
- Specified by:
getEtag
in interfaceInstanceOrBuilder
- Returns:
- The etag.
-
getEtagBytes
public com.google.protobuf.ByteString getEtagBytes()
For Resource freshness validation (https://google.aip.dev/154)
string etag = 17;
- Specified by:
getEtagBytes
in interfaceInstanceOrBuilder
- Returns:
- The bytes for etag.
-
getAnnotationsCount
public int getAnnotationsCount()
Description copied from interface:InstanceOrBuilder
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;
- Specified by:
getAnnotationsCount
in interfaceInstanceOrBuilder
-
containsAnnotations
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;
- Specified by:
containsAnnotations
in interfaceInstanceOrBuilder
-
getAnnotations
@Deprecated public Map<String,String> getAnnotations()
Deprecated.UsegetAnnotationsMap()
instead.- Specified by:
getAnnotations
in interfaceInstanceOrBuilder
-
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;
- Specified by:
getAnnotationsMap
in interfaceInstanceOrBuilder
-
getAnnotationsOrDefault
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;
- Specified by:
getAnnotationsOrDefault
in interfaceInstanceOrBuilder
-
getAnnotationsOrThrow
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;
- Specified by:
getAnnotationsOrThrow
in interfaceInstanceOrBuilder
-
hasUpdatePolicy
public boolean hasUpdatePolicy()
Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
.google.cloud.alloydb.v1beta.Instance.UpdatePolicy update_policy = 22;
- Specified by:
hasUpdatePolicy
in interfaceInstanceOrBuilder
- Returns:
- Whether the updatePolicy field is set.
-
getUpdatePolicy
public Instance.UpdatePolicy getUpdatePolicy()
Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.
.google.cloud.alloydb.v1beta.Instance.UpdatePolicy update_policy = 22;
- Specified by:
getUpdatePolicy
in interfaceInstanceOrBuilder
- Returns:
- 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.v1beta.Instance.UpdatePolicy update_policy = 22;
- Specified by:
getUpdatePolicyOrBuilder
in interfaceInstanceOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Instance parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Instance parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Instance parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Instance parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Instance parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Instance parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Instance parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Instance parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Instance parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Instance parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static Instance parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Instance parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public Instance.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Instance.Builder newBuilder()
-
newBuilder
public static Instance.Builder newBuilder(Instance prototype)
-
toBuilder
public Instance.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Instance.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static Instance getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Instance> parser()
-
getParserForType
public com.google.protobuf.Parser<Instance> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Instance getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-