Package com.google.cloud.alloydb.v1
Class Instance
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.alloydb.v1.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.v1.Instance- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classInstance.AvailabilityTypeThe Availability type of an instance.static classInstance.BuilderAn Instance is a computing unit that an end customer can connect to.static classInstance.InstanceTypeType of an Instancestatic classInstance.MachineConfigMachineConfig describes the configuration of a machine.static interfaceInstance.MachineConfigOrBuilderstatic classInstance.NodeDetails of a single node in the instance.static interfaceInstance.NodeOrBuilderstatic classInstance.QueryInsightsInstanceConfigQueryInsights Instance specific configuration.static interfaceInstance.QueryInsightsInstanceConfigOrBuilderstatic classInstance.ReadPoolConfigConfiguration for a read pool instance.static interfaceInstance.ReadPoolConfigOrBuilderstatic classInstance.StateInstance State-
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 intANNOTATIONS_FIELD_NUMBERstatic intAVAILABILITY_TYPE_FIELD_NUMBERstatic intCREATE_TIME_FIELD_NUMBERstatic intDATABASE_FLAGS_FIELD_NUMBERstatic intDELETE_TIME_FIELD_NUMBERstatic intDISPLAY_NAME_FIELD_NUMBERstatic intETAG_FIELD_NUMBERstatic intGCE_ZONE_FIELD_NUMBERstatic intINSTANCE_TYPE_FIELD_NUMBERstatic intIP_ADDRESS_FIELD_NUMBERstatic intLABELS_FIELD_NUMBERstatic intMACHINE_CONFIG_FIELD_NUMBERstatic intNAME_FIELD_NUMBERstatic intNODES_FIELD_NUMBERstatic intQUERY_INSIGHTS_CONFIG_FIELD_NUMBERstatic intREAD_POOL_CONFIG_FIELD_NUMBERstatic intRECONCILING_FIELD_NUMBERstatic intSTATE_FIELD_NUMBERstatic intUID_FIELD_NUMBERstatic intUPDATE_TIME_FIELD_NUMBERstatic intWRITABLE_NODE_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleancontainsAnnotations(String key)Annotations to allow client tools to store small amount of arbitrary data.booleancontainsDatabaseFlags(String key)Database flags.booleancontainsLabels(String key)Labels as key value pairsbooleanequals(Object obj)Map<String,String>getAnnotations()Deprecated.intgetAnnotationsCount()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.StringgetAnnotationsOrDefault(String key, String defaultValue)Annotations to allow client tools to store small amount of arbitrary data.StringgetAnnotationsOrThrow(String key)Annotations to allow client tools to store small amount of arbitrary data.Instance.AvailabilityTypegetAvailabilityType()Availability type of an Instance.intgetAvailabilityTypeValue()Availability type of an Instance.com.google.protobuf.TimestampgetCreateTime()Output only.com.google.protobuf.TimestampOrBuildergetCreateTimeOrBuilder()Output only.Map<String,String>getDatabaseFlags()Deprecated.intgetDatabaseFlagsCount()Database flags.Map<String,String>getDatabaseFlagsMap()Database flags.StringgetDatabaseFlagsOrDefault(String key, String defaultValue)Database flags.StringgetDatabaseFlagsOrThrow(String key)Database flags.static InstancegetDefaultInstance()InstancegetDefaultInstanceForType()com.google.protobuf.TimestampgetDeleteTime()Output only.com.google.protobuf.TimestampOrBuildergetDeleteTimeOrBuilder()Output only.static com.google.protobuf.Descriptors.DescriptorgetDescriptor()StringgetDisplayName()User-settable and human-readable display name for the Instance.com.google.protobuf.ByteStringgetDisplayNameBytes()User-settable and human-readable display name for the Instance.StringgetEtag()For Resource freshness validation (https://google.aip.dev/154)com.google.protobuf.ByteStringgetEtagBytes()For Resource freshness validation (https://google.aip.dev/154)StringgetGceZone()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.ByteStringgetGceZoneBytes()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.InstanceTypegetInstanceType()Required.intgetInstanceTypeValue()Required.StringgetIpAddress()Output only.com.google.protobuf.ByteStringgetIpAddressBytes()Output only.Map<String,String>getLabels()Deprecated.intgetLabelsCount()Labels as key value pairsMap<String,String>getLabelsMap()Labels as key value pairsStringgetLabelsOrDefault(String key, String defaultValue)Labels as key value pairsStringgetLabelsOrThrow(String key)Labels as key value pairsInstance.MachineConfiggetMachineConfig()Configurations for the machines that host the underlying database engine.Instance.MachineConfigOrBuildergetMachineConfigOrBuilder()Configurations for the machines that host the underlying database engine.StringgetName()Output only.com.google.protobuf.ByteStringgetNameBytes()Output only.Instance.NodegetNodes(int index)Output only.intgetNodesCount()Output only.List<Instance.Node>getNodesList()Output only.Instance.NodeOrBuildergetNodesOrBuilder(int index)Output only.List<? extends Instance.NodeOrBuilder>getNodesOrBuilderList()Output only.com.google.protobuf.Parser<Instance>getParserForType()Instance.QueryInsightsInstanceConfiggetQueryInsightsConfig()Configuration for query insights.Instance.QueryInsightsInstanceConfigOrBuildergetQueryInsightsConfigOrBuilder()Configuration for query insights.Instance.ReadPoolConfiggetReadPoolConfig()Read pool specific config.Instance.ReadPoolConfigOrBuildergetReadPoolConfigOrBuilder()Read pool specific config.booleangetReconciling()Output only.intgetSerializedSize()Instance.StategetState()Output only.intgetStateValue()Output only.StringgetUid()Output only.com.google.protobuf.ByteStringgetUidBytes()Output only.com.google.protobuf.TimestampgetUpdateTime()Output only.com.google.protobuf.TimestampOrBuildergetUpdateTimeOrBuilder()Output only.Instance.NodegetWritableNode()Output only.Instance.NodeOrBuildergetWritableNodeOrBuilder()Output only.booleanhasCreateTime()Output only.booleanhasDeleteTime()Output only.inthashCode()booleanhasMachineConfig()Configurations for the machines that host the underlying database engine.booleanhasQueryInsightsConfig()Configuration for query insights.booleanhasReadPoolConfig()Read pool specific config.booleanhasUpdateTime()Output only.booleanhasWritableNode()Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)booleanisInitialized()static Instance.BuildernewBuilder()static Instance.BuildernewBuilder(Instance prototype)Instance.BuildernewBuilderForType()protected Instance.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static InstanceparseDelimitedFrom(InputStream input)static InstanceparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static InstanceparseFrom(byte[] data)static InstanceparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static InstanceparseFrom(com.google.protobuf.ByteString data)static InstanceparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static InstanceparseFrom(com.google.protobuf.CodedInputStream input)static InstanceparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static InstanceparseFrom(InputStream input)static InstanceparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static InstanceparseFrom(ByteBuffer data)static InstanceparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<Instance>parser()Instance.BuildertoBuilder()voidwriteTo(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
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein 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:
getNamein 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:
getNameBytesin 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:
getDisplayNamein 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:
getDisplayNameBytesin 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:
getUidin 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:
getUidBytesin 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:
hasCreateTimein 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:
getCreateTimein 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:
getCreateTimeOrBuilderin interfaceInstanceOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()
Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasUpdateTimein 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:
getUpdateTimein 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:
getUpdateTimeOrBuilderin interfaceInstanceOrBuilder
-
hasDeleteTime
public boolean hasDeleteTime()
Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasDeleteTimein 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:
getDeleteTimein 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:
getDeleteTimeOrBuilderin interfaceInstanceOrBuilder
-
getLabelsCount
public int getLabelsCount()
Description copied from interface:InstanceOrBuilderLabels as key value pairs
map<string, string> labels = 7;- Specified by:
getLabelsCountin interfaceInstanceOrBuilder
-
containsLabels
public boolean containsLabels(String key)
Labels as key value pairs
map<string, string> labels = 7;- Specified by:
containsLabelsin interfaceInstanceOrBuilder
-
getLabels
@Deprecated public Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfaceInstanceOrBuilder
-
getLabelsMap
public Map<String,String> getLabelsMap()
Labels as key value pairs
map<string, string> labels = 7;- Specified by:
getLabelsMapin interfaceInstanceOrBuilder
-
getLabelsOrDefault
public String getLabelsOrDefault(String key, String defaultValue)
Labels as key value pairs
map<string, string> labels = 7;- Specified by:
getLabelsOrDefaultin interfaceInstanceOrBuilder
-
getLabelsOrThrow
public String getLabelsOrThrow(String key)
Labels as key value pairs
map<string, string> labels = 7;- Specified by:
getLabelsOrThrowin interfaceInstanceOrBuilder
-
getStateValue
public 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];- Specified by:
getStateValuein 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.v1.Instance.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStatein interfaceInstanceOrBuilder- Returns:
- The state.
-
getInstanceTypeValue
public 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];- Specified by:
getInstanceTypeValuein 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.v1.Instance.InstanceType instance_type = 9 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getInstanceTypein interfaceInstanceOrBuilder- Returns:
- The instanceType.
-
hasMachineConfig
public boolean hasMachineConfig()
Configurations for the machines that host the underlying database engine.
.google.cloud.alloydb.v1.Instance.MachineConfig machine_config = 10;- Specified by:
hasMachineConfigin 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.v1.Instance.MachineConfig machine_config = 10;- Specified by:
getMachineConfigin interfaceInstanceOrBuilder- Returns:
- The machineConfig.
-
getMachineConfigOrBuilder
public Instance.MachineConfigOrBuilder getMachineConfigOrBuilder()
Configurations for the machines that host the underlying database engine.
.google.cloud.alloydb.v1.Instance.MachineConfig machine_config = 10;- Specified by:
getMachineConfigOrBuilderin 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.v1.Instance.AvailabilityType availability_type = 11;- Specified by:
getAvailabilityTypeValuein 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.v1.Instance.AvailabilityType availability_type = 11;- Specified by:
getAvailabilityTypein 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:
getGceZonein 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:
getGceZoneBytesin interfaceInstanceOrBuilder- Returns:
- The bytes for gceZone.
-
getDatabaseFlagsCount
public int getDatabaseFlagsCount()
Description copied from interface:InstanceOrBuilderDatabase 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:
getDatabaseFlagsCountin 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:
containsDatabaseFlagsin interfaceInstanceOrBuilder
-
getDatabaseFlags
@Deprecated public Map<String,String> getDatabaseFlags()
Deprecated.UsegetDatabaseFlagsMap()instead.- Specified by:
getDatabaseFlagsin 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:
getDatabaseFlagsMapin 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:
getDatabaseFlagsOrDefaultin 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:
getDatabaseFlagsOrThrowin interfaceInstanceOrBuilder
-
hasWritableNode
public 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];- Specified by:
hasWritableNodein 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.v1.Instance.Node writable_node = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getWritableNodein 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.v1.Instance.Node writable_node = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getWritableNodeOrBuilderin 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.v1.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNodesListin 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.v1.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNodesOrBuilderListin 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.v1.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNodesCountin 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.v1.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNodesin 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.v1.Instance.Node nodes = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNodesOrBuilderin interfaceInstanceOrBuilder
-
hasQueryInsightsConfig
public boolean hasQueryInsightsConfig()
Configuration for query insights.
.google.cloud.alloydb.v1.Instance.QueryInsightsInstanceConfig query_insights_config = 21;- Specified by:
hasQueryInsightsConfigin interfaceInstanceOrBuilder- Returns:
- Whether the queryInsightsConfig field is set.
-
getQueryInsightsConfig
public Instance.QueryInsightsInstanceConfig getQueryInsightsConfig()
Configuration for query insights.
.google.cloud.alloydb.v1.Instance.QueryInsightsInstanceConfig query_insights_config = 21;- Specified by:
getQueryInsightsConfigin interfaceInstanceOrBuilder- Returns:
- The queryInsightsConfig.
-
getQueryInsightsConfigOrBuilder
public Instance.QueryInsightsInstanceConfigOrBuilder getQueryInsightsConfigOrBuilder()
Configuration for query insights.
.google.cloud.alloydb.v1.Instance.QueryInsightsInstanceConfig query_insights_config = 21;- Specified by:
getQueryInsightsConfigOrBuilderin interfaceInstanceOrBuilder
-
hasReadPoolConfig
public boolean hasReadPoolConfig()
Read pool specific config.
.google.cloud.alloydb.v1.Instance.ReadPoolConfig read_pool_config = 14;- Specified by:
hasReadPoolConfigin interfaceInstanceOrBuilder- Returns:
- Whether the readPoolConfig field is set.
-
getReadPoolConfig
public Instance.ReadPoolConfig getReadPoolConfig()
Read pool specific config.
.google.cloud.alloydb.v1.Instance.ReadPoolConfig read_pool_config = 14;- Specified by:
getReadPoolConfigin interfaceInstanceOrBuilder- Returns:
- The readPoolConfig.
-
getReadPoolConfigOrBuilder
public Instance.ReadPoolConfigOrBuilder getReadPoolConfigOrBuilder()
Read pool specific config.
.google.cloud.alloydb.v1.Instance.ReadPoolConfig read_pool_config = 14;- Specified by:
getReadPoolConfigOrBuilderin 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:
getIpAddressin 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:
getIpAddressBytesin 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:
getReconcilingin interfaceInstanceOrBuilder- Returns:
- The reconciling.
-
getEtag
public String getEtag()
For Resource freshness validation (https://google.aip.dev/154)
string etag = 17;- Specified by:
getEtagin 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:
getEtagBytesin interfaceInstanceOrBuilder- Returns:
- The bytes for etag.
-
getAnnotationsCount
public int getAnnotationsCount()
Description copied from interface:InstanceOrBuilderAnnotations 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:
getAnnotationsCountin 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:
containsAnnotationsin interfaceInstanceOrBuilder
-
getAnnotations
@Deprecated public Map<String,String> getAnnotations()
Deprecated.UsegetAnnotationsMap()instead.- Specified by:
getAnnotationsin 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:
getAnnotationsMapin 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:
getAnnotationsOrDefaultin 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:
getAnnotationsOrThrowin interfaceInstanceOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein 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:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein 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:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Instance.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein 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:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Instance getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-