Class SupportedDatabaseFlag (0.24.0)

public final class SupportedDatabaseFlag extends GeneratedMessageV3 implements SupportedDatabaseFlagOrBuilder

SupportedDatabaseFlag gives general information about a database flag, like type and allowed values. This is a static value that is defined on the server side, and it cannot be modified by callers. To set the Database flags on a particular Instance, a caller should modify the Instance.database_flags field.

Protobuf type google.cloud.alloydb.v1beta.SupportedDatabaseFlag

Static Fields

ACCEPTS_MULTIPLE_VALUES_FIELD_NUMBER

public static final int ACCEPTS_MULTIPLE_VALUES_FIELD_NUMBER
Field Value
Type Description
int

FLAG_NAME_FIELD_NUMBER

public static final int FLAG_NAME_FIELD_NUMBER
Field Value
Type Description
int

INTEGER_RESTRICTIONS_FIELD_NUMBER

public static final int INTEGER_RESTRICTIONS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REQUIRES_DB_RESTART_FIELD_NUMBER

public static final int REQUIRES_DB_RESTART_FIELD_NUMBER
Field Value
Type Description
int

STRING_RESTRICTIONS_FIELD_NUMBER

public static final int STRING_RESTRICTIONS_FIELD_NUMBER
Field Value
Type Description
int

SUPPORTED_DB_VERSIONS_FIELD_NUMBER

public static final int SUPPORTED_DB_VERSIONS_FIELD_NUMBER
Field Value
Type Description
int

VALUE_TYPE_FIELD_NUMBER

public static final int VALUE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SupportedDatabaseFlag getDefaultInstance()
Returns
Type Description
SupportedDatabaseFlag

getDescriptor()

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

newBuilder()

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

newBuilder(SupportedDatabaseFlag prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAcceptsMultipleValues()

public boolean getAcceptsMultipleValues()

Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.

bool accepts_multiple_values = 4;

Returns
Type Description
boolean

The acceptsMultipleValues.

getDefaultInstanceForType()

public SupportedDatabaseFlag getDefaultInstanceForType()
Returns
Type Description
SupportedDatabaseFlag

getFlagName()

public String getFlagName()

The name of the database flag, e.g. "max_allowed_packets". The is a possibly key for the Instance.database_flags map field.

string flag_name = 2;

Returns
Type Description
String

The flagName.

getFlagNameBytes()

public ByteString getFlagNameBytes()

The name of the database flag, e.g. "max_allowed_packets". The is a possibly key for the Instance.database_flags map field.

string flag_name = 2;

Returns
Type Description
ByteString

The bytes for flagName.

getIntegerRestrictions()

public SupportedDatabaseFlag.IntegerRestrictions getIntegerRestrictions()

Restriction on INTEGER type value.

.google.cloud.alloydb.v1beta.SupportedDatabaseFlag.IntegerRestrictions integer_restrictions = 8;

Returns
Type Description
SupportedDatabaseFlag.IntegerRestrictions

The integerRestrictions.

getIntegerRestrictionsOrBuilder()

public SupportedDatabaseFlag.IntegerRestrictionsOrBuilder getIntegerRestrictionsOrBuilder()

Restriction on INTEGER type value.

.google.cloud.alloydb.v1beta.SupportedDatabaseFlag.IntegerRestrictions integer_restrictions = 8;

Returns
Type Description
SupportedDatabaseFlag.IntegerRestrictionsOrBuilder

getName()

public String getName()

The name of the flag resource, following Google Cloud conventions, e.g.:

  • projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the flag resource, following Google Cloud conventions, e.g.:

  • projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getRequiresDbRestart()

public boolean getRequiresDbRestart()

Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).

bool requires_db_restart = 6;

Returns
Type Description
boolean

The requiresDbRestart.

getRestrictionsCase()

public SupportedDatabaseFlag.RestrictionsCase getRestrictionsCase()
Returns
Type Description
SupportedDatabaseFlag.RestrictionsCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStringRestrictions()

public SupportedDatabaseFlag.StringRestrictions getStringRestrictions()

Restriction on STRING type value.

.google.cloud.alloydb.v1beta.SupportedDatabaseFlag.StringRestrictions string_restrictions = 7;

Returns
Type Description
SupportedDatabaseFlag.StringRestrictions

The stringRestrictions.

getStringRestrictionsOrBuilder()

public SupportedDatabaseFlag.StringRestrictionsOrBuilder getStringRestrictionsOrBuilder()

Restriction on STRING type value.

.google.cloud.alloydb.v1beta.SupportedDatabaseFlag.StringRestrictions string_restrictions = 7;

Returns
Type Description
SupportedDatabaseFlag.StringRestrictionsOrBuilder

getSupportedDbVersions(int index)

public DatabaseVersion getSupportedDbVersions(int index)

Major database engine versions for which this flag is supported.

repeated .google.cloud.alloydb.v1beta.DatabaseVersion supported_db_versions = 5;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
DatabaseVersion

The supportedDbVersions at the given index.

getSupportedDbVersionsCount()

public int getSupportedDbVersionsCount()

Major database engine versions for which this flag is supported.

repeated .google.cloud.alloydb.v1beta.DatabaseVersion supported_db_versions = 5;

Returns
Type Description
int

The count of supportedDbVersions.

getSupportedDbVersionsList()

public List<DatabaseVersion> getSupportedDbVersionsList()

Major database engine versions for which this flag is supported.

repeated .google.cloud.alloydb.v1beta.DatabaseVersion supported_db_versions = 5;

Returns
Type Description
List<DatabaseVersion>

A list containing the supportedDbVersions.

getSupportedDbVersionsValue(int index)

public int getSupportedDbVersionsValue(int index)

Major database engine versions for which this flag is supported.

repeated .google.cloud.alloydb.v1beta.DatabaseVersion supported_db_versions = 5;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of supportedDbVersions at the given index.

getSupportedDbVersionsValueList()

public List<Integer> getSupportedDbVersionsValueList()

Major database engine versions for which this flag is supported.

repeated .google.cloud.alloydb.v1beta.DatabaseVersion supported_db_versions = 5;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for supportedDbVersions.

getValueType()

public SupportedDatabaseFlag.ValueType getValueType()

.google.cloud.alloydb.v1beta.SupportedDatabaseFlag.ValueType value_type = 3;

Returns
Type Description
SupportedDatabaseFlag.ValueType

The valueType.

getValueTypeValue()

public int getValueTypeValue()

.google.cloud.alloydb.v1beta.SupportedDatabaseFlag.ValueType value_type = 3;

Returns
Type Description
int

The enum numeric value on the wire for valueType.

hasIntegerRestrictions()

public boolean hasIntegerRestrictions()

Restriction on INTEGER type value.

.google.cloud.alloydb.v1beta.SupportedDatabaseFlag.IntegerRestrictions integer_restrictions = 8;

Returns
Type Description
boolean

Whether the integerRestrictions field is set.

hasStringRestrictions()

public boolean hasStringRestrictions()

Restriction on STRING type value.

.google.cloud.alloydb.v1beta.SupportedDatabaseFlag.StringRestrictions string_restrictions = 7;

Returns
Type Description
boolean

Whether the stringRestrictions field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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