Class: Google::Apis::AlloydbV1::SupportedDatabaseFlag

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/alloydb_v1/classes.rb,
lib/google/apis/alloydb_v1/representations.rb,
lib/google/apis/alloydb_v1/representations.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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SupportedDatabaseFlag

Returns a new instance of SupportedDatabaseFlag.



5061
5062
5063
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 5061

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#accepts_multiple_values ⇒ Boolean Also known as: accepts_multiple_values?

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

Returns:

  • (Boolean) 


5001
5002
5003
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 5001

def accepts_multiple_values
  @accepts_multiple_values
end

#flag_name ⇒ String

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

Returns:

  • (String) 


5008
5009
5010
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 5008

def flag_name
  @flag_name
end

#integer_restrictions ⇒ Google::Apis::AlloydbV1::IntegerRestrictions

Restrictions on INTEGER type values. Corresponds to the JSON property integerRestrictions

Returns:



5013
5014
5015
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 5013

def integer_restrictions
  @integer_restrictions
end

#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. Corresponds to the JSON property name

Returns:

  • (String) 


5020
5021
5022
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 5020

def name
  @name
end

#recommended_integer_value ⇒ Fixnum

The recommended value for an INTEGER flag. Corresponds to the JSON property recommendedIntegerValue

Returns:

  • (Fixnum) 


5025
5026
5027
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 5025

def recommended_integer_value
  @recommended_integer_value
end

#recommended_string_value ⇒ String

The recommended value for a STRING flag. Corresponds to the JSON property recommendedStringValue

Returns:

  • (String) 


5030
5031
5032
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 5030

def recommended_string_value
  @recommended_string_value
end

#requires_db_restart ⇒ Boolean Also known as: requires_db_restart?

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). Corresponds to the JSON property requiresDbRestart

Returns:

  • (Boolean) 


5038
5039
5040
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 5038

def requires_db_restart
  @requires_db_restart
end

#scope ⇒ String

The scope of the flag. Corresponds to the JSON property scope

Returns:

  • (String) 


5044
5045
5046
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 5044

def scope
  @scope
end

#string_restrictions ⇒ Google::Apis::AlloydbV1::StringRestrictions

Restrictions on STRING type values Corresponds to the JSON property stringRestrictions

Returns:



5049
5050
5051
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 5049

def string_restrictions
  @string_restrictions
end

#supported_db_versions ⇒ Array<String>

Major database engine versions for which this flag is supported. Corresponds to the JSON property supportedDbVersions

Returns:

  • (Array<String>) 


5054
5055
5056
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 5054

def supported_db_versions
  @supported_db_versions
end

#value_type ⇒ String

Corresponds to the JSON property valueType

Returns:

  • (String) 


5059
5060
5061
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 5059

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 5066

def update!(**args)
  @accepts_multiple_values = args[:accepts_multiple_values] if args.key?(:accepts_multiple_values)
  @flag_name = args[:flag_name] if args.key?(:flag_name)
  @integer_restrictions = args[:integer_restrictions] if args.key?(:integer_restrictions)
  @name = args[:name] if args.key?(:name)
  @recommended_integer_value = args[:recommended_integer_value] if args.key?(:recommended_integer_value)
  @recommended_string_value = args[:recommended_string_value] if args.key?(:recommended_string_value)
  @requires_db_restart = args[:requires_db_restart] if args.key?(:requires_db_restart)
  @scope = args[:scope] if args.key?(:scope)
  @string_restrictions = args[:string_restrictions] if args.key?(:string_restrictions)
  @supported_db_versions = args[:supported_db_versions] if args.key?(:supported_db_versions)
  @value_type = args[:value_type] if args.key?(:value_type)
end