Class: Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag

Inherits:

Object

Object
Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/alloydb/v1/resources.rb

Overview

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.

Defined Under Namespace

Modules: Scope, ValueType Classes: IntegerRestrictions, StringRestrictions

Instance Attribute Summary collapse

#accepts_multiple_values ⇒ ::Boolean
Whether the database flag accepts multiple values.
#flag_name ⇒ ::String
The name of the database flag, e.g.
#integer_restrictions ⇒ ::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::IntegerRestrictions
Restriction on INTEGER type value.
#name ⇒ ::String
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.
#recommended_integer_value ⇒ ::Google::Protobuf::Int64Value
The recommended value for an INTEGER flag.
#recommended_string_value ⇒ ::String
The recommended value for a STRING flag.
#requires_db_restart ⇒ ::Boolean
Whether setting or updating this flag on an Instance requires a database restart.
#scope ⇒ ::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::Scope
The scope of the flag.
#string_restrictions ⇒ ::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::StringRestrictions
Restriction on STRING type value.
#supported_db_versions ⇒ ::Array<::Google::Cloud::AlloyDB::V1::DatabaseVersion>
Major database engine versions for which this flag is supported.
#value_type ⇒ ::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::ValueType

Instance Attribute Details

#accepts_multiple_values ⇒ `::Boolean`

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

Returns:

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

# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1532

class SupportedDatabaseFlag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restrictions on STRING type values
  # @!attribute [rw] allowed_values
  #   @return [::Array<::String>]
  #     The list of allowed values, if bounded. This field will be empty
  #     if there is a unbounded number of allowed values.
  class StringRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restrictions on INTEGER type values.
  # @!attribute [rw] min_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The minimum value that can be specified, if applicable.
  # @!attribute [rw] max_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The maximum value that can be specified, if applicable.
  class IntegerRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ValueType describes the semantic type of the value that the flag accepts.
  # Regardless of the ValueType, the Instance.database_flags field accepts the
  # stringified version of the value, i.e. "20" or "3.14".
  module ValueType
    # This is an unknown flag type.
    VALUE_TYPE_UNSPECIFIED = 0

    # String type flag.
    STRING = 1

    # Integer type flag.
    INTEGER = 2

    # Float type flag.
    FLOAT = 3

    # Denotes that the flag does not accept any values.
    NONE = 4
  end

  # The scope of the flag.
  module Scope
    # The scope of the flag is not specified. Default is DATABASE.
    SCOPE_UNSPECIFIED = 0

    # The flag is a database flag.
    DATABASE = 1

    # The flag is a connection pool flag.
    CONNECTION_POOL = 2
  end
end

#flag_name ⇒ `::String`

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

Returns:

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

# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1532

class SupportedDatabaseFlag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restrictions on STRING type values
  # @!attribute [rw] allowed_values
  #   @return [::Array<::String>]
  #     The list of allowed values, if bounded. This field will be empty
  #     if there is a unbounded number of allowed values.
  class StringRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restrictions on INTEGER type values.
  # @!attribute [rw] min_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The minimum value that can be specified, if applicable.
  # @!attribute [rw] max_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The maximum value that can be specified, if applicable.
  class IntegerRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ValueType describes the semantic type of the value that the flag accepts.
  # Regardless of the ValueType, the Instance.database_flags field accepts the
  # stringified version of the value, i.e. "20" or "3.14".
  module ValueType
    # This is an unknown flag type.
    VALUE_TYPE_UNSPECIFIED = 0

    # String type flag.
    STRING = 1

    # Integer type flag.
    INTEGER = 2

    # Float type flag.
    FLOAT = 3

    # Denotes that the flag does not accept any values.
    NONE = 4
  end

  # The scope of the flag.
  module Scope
    # The scope of the flag is not specified. Default is DATABASE.
    SCOPE_UNSPECIFIED = 0

    # The flag is a database flag.
    DATABASE = 1

    # The flag is a connection pool flag.
    CONNECTION_POOL = 2
  end
end

#integer_restrictions ⇒ `::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::IntegerRestrictions`

Returns Restriction on INTEGER type value.

Note: The following fields are mutually exclusive: integer_restrictions, string_restrictions. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::IntegerRestrictions) —
Restriction on INTEGER type value.

Note: The following fields are mutually exclusive: integer_restrictions, string_restrictions. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1532

class SupportedDatabaseFlag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restrictions on STRING type values
  # @!attribute [rw] allowed_values
  #   @return [::Array<::String>]
  #     The list of allowed values, if bounded. This field will be empty
  #     if there is a unbounded number of allowed values.
  class StringRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restrictions on INTEGER type values.
  # @!attribute [rw] min_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The minimum value that can be specified, if applicable.
  # @!attribute [rw] max_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The maximum value that can be specified, if applicable.
  class IntegerRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ValueType describes the semantic type of the value that the flag accepts.
  # Regardless of the ValueType, the Instance.database_flags field accepts the
  # stringified version of the value, i.e. "20" or "3.14".
  module ValueType
    # This is an unknown flag type.
    VALUE_TYPE_UNSPECIFIED = 0

    # String type flag.
    STRING = 1

    # Integer type flag.
    INTEGER = 2

    # Float type flag.
    FLOAT = 3

    # Denotes that the flag does not accept any values.
    NONE = 4
  end

  # The scope of the flag.
  module Scope
    # The scope of the flag is not specified. Default is DATABASE.
    SCOPE_UNSPECIFIED = 0

    # The flag is a database flag.
    DATABASE = 1

    # The flag is a connection pool flag.
    CONNECTION_POOL = 2
  end
end

#name ⇒ `::String`

Returns 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.

Returns:

(::String) —
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.

# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1532

class SupportedDatabaseFlag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restrictions on STRING type values
  # @!attribute [rw] allowed_values
  #   @return [::Array<::String>]
  #     The list of allowed values, if bounded. This field will be empty
  #     if there is a unbounded number of allowed values.
  class StringRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restrictions on INTEGER type values.
  # @!attribute [rw] min_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The minimum value that can be specified, if applicable.
  # @!attribute [rw] max_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The maximum value that can be specified, if applicable.
  class IntegerRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ValueType describes the semantic type of the value that the flag accepts.
  # Regardless of the ValueType, the Instance.database_flags field accepts the
  # stringified version of the value, i.e. "20" or "3.14".
  module ValueType
    # This is an unknown flag type.
    VALUE_TYPE_UNSPECIFIED = 0

    # String type flag.
    STRING = 1

    # Integer type flag.
    INTEGER = 2

    # Float type flag.
    FLOAT = 3

    # Denotes that the flag does not accept any values.
    NONE = 4
  end

  # The scope of the flag.
  module Scope
    # The scope of the flag is not specified. Default is DATABASE.
    SCOPE_UNSPECIFIED = 0

    # The flag is a database flag.
    DATABASE = 1

    # The flag is a connection pool flag.
    CONNECTION_POOL = 2
  end
end

#recommended_integer_value ⇒ `::Google::Protobuf::Int64Value`

Returns The recommended value for an INTEGER flag.

Note: The following fields are mutually exclusive: recommended_integer_value, recommended_string_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Protobuf::Int64Value) —
The recommended value for an INTEGER flag.

Note: The following fields are mutually exclusive: recommended_integer_value, recommended_string_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1532

class SupportedDatabaseFlag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restrictions on STRING type values
  # @!attribute [rw] allowed_values
  #   @return [::Array<::String>]
  #     The list of allowed values, if bounded. This field will be empty
  #     if there is a unbounded number of allowed values.
  class StringRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restrictions on INTEGER type values.
  # @!attribute [rw] min_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The minimum value that can be specified, if applicable.
  # @!attribute [rw] max_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The maximum value that can be specified, if applicable.
  class IntegerRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ValueType describes the semantic type of the value that the flag accepts.
  # Regardless of the ValueType, the Instance.database_flags field accepts the
  # stringified version of the value, i.e. "20" or "3.14".
  module ValueType
    # This is an unknown flag type.
    VALUE_TYPE_UNSPECIFIED = 0

    # String type flag.
    STRING = 1

    # Integer type flag.
    INTEGER = 2

    # Float type flag.
    FLOAT = 3

    # Denotes that the flag does not accept any values.
    NONE = 4
  end

  # The scope of the flag.
  module Scope
    # The scope of the flag is not specified. Default is DATABASE.
    SCOPE_UNSPECIFIED = 0

    # The flag is a database flag.
    DATABASE = 1

    # The flag is a connection pool flag.
    CONNECTION_POOL = 2
  end
end

#recommended_string_value ⇒ `::String`

Returns The recommended value for a STRING flag.

Note: The following fields are mutually exclusive: recommended_string_value, recommended_integer_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::String) —
The recommended value for a STRING flag.

Note: The following fields are mutually exclusive: recommended_string_value, recommended_integer_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1532

class SupportedDatabaseFlag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restrictions on STRING type values
  # @!attribute [rw] allowed_values
  #   @return [::Array<::String>]
  #     The list of allowed values, if bounded. This field will be empty
  #     if there is a unbounded number of allowed values.
  class StringRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restrictions on INTEGER type values.
  # @!attribute [rw] min_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The minimum value that can be specified, if applicable.
  # @!attribute [rw] max_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The maximum value that can be specified, if applicable.
  class IntegerRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ValueType describes the semantic type of the value that the flag accepts.
  # Regardless of the ValueType, the Instance.database_flags field accepts the
  # stringified version of the value, i.e. "20" or "3.14".
  module ValueType
    # This is an unknown flag type.
    VALUE_TYPE_UNSPECIFIED = 0

    # String type flag.
    STRING = 1

    # Integer type flag.
    INTEGER = 2

    # Float type flag.
    FLOAT = 3

    # Denotes that the flag does not accept any values.
    NONE = 4
  end

  # The scope of the flag.
  module Scope
    # The scope of the flag is not specified. Default is DATABASE.
    SCOPE_UNSPECIFIED = 0

    # The flag is a database flag.
    DATABASE = 1

    # The flag is a connection pool flag.
    CONNECTION_POOL = 2
  end
end

#requires_db_restart ⇒ `::Boolean`

Returns 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).

Returns:

(::Boolean) —
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).

# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1532

class SupportedDatabaseFlag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restrictions on STRING type values
  # @!attribute [rw] allowed_values
  #   @return [::Array<::String>]
  #     The list of allowed values, if bounded. This field will be empty
  #     if there is a unbounded number of allowed values.
  class StringRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restrictions on INTEGER type values.
  # @!attribute [rw] min_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The minimum value that can be specified, if applicable.
  # @!attribute [rw] max_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The maximum value that can be specified, if applicable.
  class IntegerRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ValueType describes the semantic type of the value that the flag accepts.
  # Regardless of the ValueType, the Instance.database_flags field accepts the
  # stringified version of the value, i.e. "20" or "3.14".
  module ValueType
    # This is an unknown flag type.
    VALUE_TYPE_UNSPECIFIED = 0

    # String type flag.
    STRING = 1

    # Integer type flag.
    INTEGER = 2

    # Float type flag.
    FLOAT = 3

    # Denotes that the flag does not accept any values.
    NONE = 4
  end

  # The scope of the flag.
  module Scope
    # The scope of the flag is not specified. Default is DATABASE.
    SCOPE_UNSPECIFIED = 0

    # The flag is a database flag.
    DATABASE = 1

    # The flag is a connection pool flag.
    CONNECTION_POOL = 2
  end
end

#scope ⇒ `::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::Scope`

Returns The scope of the flag.

Returns:

(::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::Scope) —
The scope of the flag.

# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1532

class SupportedDatabaseFlag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restrictions on STRING type values
  # @!attribute [rw] allowed_values
  #   @return [::Array<::String>]
  #     The list of allowed values, if bounded. This field will be empty
  #     if there is a unbounded number of allowed values.
  class StringRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restrictions on INTEGER type values.
  # @!attribute [rw] min_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The minimum value that can be specified, if applicable.
  # @!attribute [rw] max_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The maximum value that can be specified, if applicable.
  class IntegerRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ValueType describes the semantic type of the value that the flag accepts.
  # Regardless of the ValueType, the Instance.database_flags field accepts the
  # stringified version of the value, i.e. "20" or "3.14".
  module ValueType
    # This is an unknown flag type.
    VALUE_TYPE_UNSPECIFIED = 0

    # String type flag.
    STRING = 1

    # Integer type flag.
    INTEGER = 2

    # Float type flag.
    FLOAT = 3

    # Denotes that the flag does not accept any values.
    NONE = 4
  end

  # The scope of the flag.
  module Scope
    # The scope of the flag is not specified. Default is DATABASE.
    SCOPE_UNSPECIFIED = 0

    # The flag is a database flag.
    DATABASE = 1

    # The flag is a connection pool flag.
    CONNECTION_POOL = 2
  end
end

#string_restrictions ⇒ `::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::StringRestrictions`

Returns Restriction on STRING type value.

Note: The following fields are mutually exclusive: string_restrictions, integer_restrictions. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

(::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::StringRestrictions) —
Restriction on STRING type value.

Note: The following fields are mutually exclusive: string_restrictions, integer_restrictions. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1532

class SupportedDatabaseFlag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restrictions on STRING type values
  # @!attribute [rw] allowed_values
  #   @return [::Array<::String>]
  #     The list of allowed values, if bounded. This field will be empty
  #     if there is a unbounded number of allowed values.
  class StringRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restrictions on INTEGER type values.
  # @!attribute [rw] min_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The minimum value that can be specified, if applicable.
  # @!attribute [rw] max_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The maximum value that can be specified, if applicable.
  class IntegerRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ValueType describes the semantic type of the value that the flag accepts.
  # Regardless of the ValueType, the Instance.database_flags field accepts the
  # stringified version of the value, i.e. "20" or "3.14".
  module ValueType
    # This is an unknown flag type.
    VALUE_TYPE_UNSPECIFIED = 0

    # String type flag.
    STRING = 1

    # Integer type flag.
    INTEGER = 2

    # Float type flag.
    FLOAT = 3

    # Denotes that the flag does not accept any values.
    NONE = 4
  end

  # The scope of the flag.
  module Scope
    # The scope of the flag is not specified. Default is DATABASE.
    SCOPE_UNSPECIFIED = 0

    # The flag is a database flag.
    DATABASE = 1

    # The flag is a connection pool flag.
    CONNECTION_POOL = 2
  end
end

#supported_db_versions ⇒ `::Array<::Google::Cloud::AlloyDB::V1::DatabaseVersion>`

Returns Major database engine versions for which this flag is supported.

Returns:

(::Array<::Google::Cloud::AlloyDB::V1::DatabaseVersion>) —
Major database engine versions for which this flag is supported.

# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1532

class SupportedDatabaseFlag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restrictions on STRING type values
  # @!attribute [rw] allowed_values
  #   @return [::Array<::String>]
  #     The list of allowed values, if bounded. This field will be empty
  #     if there is a unbounded number of allowed values.
  class StringRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restrictions on INTEGER type values.
  # @!attribute [rw] min_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The minimum value that can be specified, if applicable.
  # @!attribute [rw] max_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The maximum value that can be specified, if applicable.
  class IntegerRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ValueType describes the semantic type of the value that the flag accepts.
  # Regardless of the ValueType, the Instance.database_flags field accepts the
  # stringified version of the value, i.e. "20" or "3.14".
  module ValueType
    # This is an unknown flag type.
    VALUE_TYPE_UNSPECIFIED = 0

    # String type flag.
    STRING = 1

    # Integer type flag.
    INTEGER = 2

    # Float type flag.
    FLOAT = 3

    # Denotes that the flag does not accept any values.
    NONE = 4
  end

  # The scope of the flag.
  module Scope
    # The scope of the flag is not specified. Default is DATABASE.
    SCOPE_UNSPECIFIED = 0

    # The flag is a database flag.
    DATABASE = 1

    # The flag is a connection pool flag.
    CONNECTION_POOL = 2
  end
end

#value_type ⇒ `::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::ValueType`

Returns:

(::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::ValueType)

# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1532

class SupportedDatabaseFlag
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restrictions on STRING type values
  # @!attribute [rw] allowed_values
  #   @return [::Array<::String>]
  #     The list of allowed values, if bounded. This field will be empty
  #     if there is a unbounded number of allowed values.
  class StringRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Restrictions on INTEGER type values.
  # @!attribute [rw] min_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The minimum value that can be specified, if applicable.
  # @!attribute [rw] max_value
  #   @return [::Google::Protobuf::Int64Value]
  #     The maximum value that can be specified, if applicable.
  class IntegerRestrictions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ValueType describes the semantic type of the value that the flag accepts.
  # Regardless of the ValueType, the Instance.database_flags field accepts the
  # stringified version of the value, i.e. "20" or "3.14".
  module ValueType
    # This is an unknown flag type.
    VALUE_TYPE_UNSPECIFIED = 0

    # String type flag.
    STRING = 1

    # Integer type flag.
    INTEGER = 2

    # Float type flag.
    FLOAT = 3

    # Denotes that the flag does not accept any values.
    NONE = 4
  end

  # The scope of the flag.
  module Scope
    # The scope of the flag is not specified. Default is DATABASE.
    SCOPE_UNSPECIFIED = 0

    # The flag is a database flag.
    DATABASE = 1

    # The flag is a connection pool flag.
    CONNECTION_POOL = 2
  end
end

Class: Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#accepts_multiple_values ⇒ ::Boolean

#flag_name ⇒ ::String

#integer_restrictions ⇒ ::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::IntegerRestrictions

#name ⇒ ::String

#recommended_integer_value ⇒ ::Google::Protobuf::Int64Value

#recommended_string_value ⇒ ::String

#requires_db_restart ⇒ ::Boolean

#scope ⇒ ::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::Scope

#string_restrictions ⇒ ::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::StringRestrictions

#supported_db_versions ⇒ ::Array<::Google::Cloud::AlloyDB::V1::DatabaseVersion>

#value_type ⇒ ::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::ValueType

#accepts_multiple_values ⇒ `::Boolean`

#flag_name ⇒ `::String`

#integer_restrictions ⇒ `::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::IntegerRestrictions`

#name ⇒ `::String`

#recommended_integer_value ⇒ `::Google::Protobuf::Int64Value`

#recommended_string_value ⇒ `::String`

#requires_db_restart ⇒ `::Boolean`

#scope ⇒ `::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::Scope`

#string_restrictions ⇒ `::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::StringRestrictions`

#supported_db_versions ⇒ `::Array<::Google::Cloud::AlloyDB::V1::DatabaseVersion>`

#value_type ⇒ `::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::ValueType`