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.



3485
3486
3487
# File 'lib/google/apis/alloydb_v1/classes.rb', line 3485

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

Instance Attribute Details

#accepts_multiple_valuesBoolean 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)


3440
3441
3442
# File 'lib/google/apis/alloydb_v1/classes.rb', line 3440

def accepts_multiple_values
  @accepts_multiple_values
end

#flag_nameString

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)


3447
3448
3449
# File 'lib/google/apis/alloydb_v1/classes.rb', line 3447

def flag_name
  @flag_name
end

#integer_restrictionsGoogle::Apis::AlloydbV1::IntegerRestrictions

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



3452
3453
3454
# File 'lib/google/apis/alloydb_v1/classes.rb', line 3452

def integer_restrictions
  @integer_restrictions
end

#nameString

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)


3459
3460
3461
# File 'lib/google/apis/alloydb_v1/classes.rb', line 3459

def name
  @name
end

#requires_db_restartBoolean 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)


3467
3468
3469
# File 'lib/google/apis/alloydb_v1/classes.rb', line 3467

def requires_db_restart
  @requires_db_restart
end

#string_restrictionsGoogle::Apis::AlloydbV1::StringRestrictions

Restrictions on STRING type values Corresponds to the JSON property stringRestrictions



3473
3474
3475
# File 'lib/google/apis/alloydb_v1/classes.rb', line 3473

def string_restrictions
  @string_restrictions
end

#supported_db_versionsArray<String>

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

Returns:

  • (Array<String>)


3478
3479
3480
# File 'lib/google/apis/alloydb_v1/classes.rb', line 3478

def supported_db_versions
  @supported_db_versions
end

#value_typeString

Corresponds to the JSON property valueType

Returns:

  • (String)


3483
3484
3485
# File 'lib/google/apis/alloydb_v1/classes.rb', line 3483

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
# File 'lib/google/apis/alloydb_v1/classes.rb', line 3490

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)
  @requires_db_restart = args[:requires_db_restart] if args.key?(:requires_db_restart)
  @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