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

Inherits:
Object
  • Object
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: ValueType Classes: IntegerRestrictions, StringRestrictions

Instance Attribute Summary collapse

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.



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1083

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



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1083

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
end

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

Returns Restriction on INTEGER type value.

Returns:



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1083

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


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1083

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



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1083

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
end

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

Returns Restriction on STRING type value.

Returns:



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1083

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
end

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

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

Returns:



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1083

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
end

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

Returns:



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 1083

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
end