Class: Google::Apis::SqladminV1::Flag

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sqladmin_v1/classes.rb,
lib/google/apis/sqladmin_v1/representations.rb,
lib/google/apis/sqladmin_v1/representations.rb

Overview

A flag resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Flag

Returns a new instance of Flag.



2473
2474
2475
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2473

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

Instance Attribute Details

#allowed_int_values ⇒ Array<Fixnum>

Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values. Corresponds to the JSON property allowedIntValues

Returns:

  • (Array<Fixnum>) 


2399
2400
2401
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2399

def allowed_int_values
  @allowed_int_values
end

#allowed_string_values ⇒ Array<String>

For STRING flags, a list of strings that the value can be set to. Corresponds to the JSON property allowedStringValues

Returns:

  • (Array<String>) 


2404
2405
2406
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2404

def allowed_string_values
  @allowed_string_values
end

#applies_to ⇒ Array<String>

The database version this flag applies to. Can be MySQL instances: MYSQL_8_0, MYSQL_8_0_18, MYSQL_8_0_26, MYSQL_5_7, or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11 or POSTGRES_12. SQL Server instances: SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB, SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB. See the complete list. Corresponds to the JSON property appliesTo

Returns:

  • (Array<String>) 


2415
2416
2417
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2415

def applies_to
  @applies_to
end

#flag_scope ⇒ String

Scope of flag. Corresponds to the JSON property flagScope

Returns:

  • (String) 


2420
2421
2422
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2420

def flag_scope
  @flag_scope
end

#in_beta ⇒ Boolean Also known as: in_beta?

Whether or not the flag is considered in beta. Corresponds to the JSON property inBeta

Returns:

  • (Boolean) 


2425
2426
2427
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2425

def in_beta
  @in_beta
end

#kind ⇒ String

This is always sql#flag. Corresponds to the JSON property kind

Returns:

  • (String) 


2431
2432
2433
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2431

def kind
  @kind
end

#max_value ⇒ Fixnum

For INTEGER flags, the maximum allowed value. Corresponds to the JSON property maxValue

Returns:

  • (Fixnum) 


2436
2437
2438
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2436

def max_value
  @max_value
end

#min_value ⇒ Fixnum

For INTEGER flags, the minimum allowed value. Corresponds to the JSON property minValue

Returns:

  • (Fixnum) 


2441
2442
2443
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2441

def min_value
  @min_value
end

#name ⇒ String

This is the name of the flag. Flag names always use underscores, not hyphens, for example: max_allowed_packet Corresponds to the JSON property name

Returns:

  • (String) 


2447
2448
2449
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2447

def name
  @name
end

#recommended_int_value ⇒ Fixnum

Recommended int value in integer format for UI display. Corresponds to the JSON property recommendedIntValue

Returns:

  • (Fixnum) 


2452
2453
2454
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2452

def recommended_int_value
  @recommended_int_value
end

#recommended_string_value ⇒ String

Recommended string value in string format for UI display. Corresponds to the JSON property recommendedStringValue

Returns:

  • (String) 


2457
2458
2459
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2457

def recommended_string_value
  @recommended_string_value
end

#requires_restart ⇒ Boolean Also known as: requires_restart?

Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances. Corresponds to the JSON property requiresRestart

Returns:

  • (Boolean) 


2463
2464
2465
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2463

def requires_restart
  @requires_restart
end

#type ⇒ String

The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags that do not take a value, such as skip_grant_tables. Corresponds to the JSON property type

Returns:

  • (String) 


2471
2472
2473
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2471

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 2478

def update!(**args)
  @allowed_int_values = args[:allowed_int_values] if args.key?(:allowed_int_values)
  @allowed_string_values = args[:allowed_string_values] if args.key?(:allowed_string_values)
  @applies_to = args[:applies_to] if args.key?(:applies_to)
  @flag_scope = args[:flag_scope] if args.key?(:flag_scope)
  @in_beta = args[:in_beta] if args.key?(:in_beta)
  @kind = args[:kind] if args.key?(:kind)
  @max_value = args[:max_value] if args.key?(:max_value)
  @min_value = args[:min_value] if args.key?(:min_value)
  @name = args[:name] if args.key?(:name)
  @recommended_int_value = args[:recommended_int_value] if args.key?(:recommended_int_value)
  @recommended_string_value = args[:recommended_string_value] if args.key?(:recommended_string_value)
  @requires_restart = args[:requires_restart] if args.key?(:requires_restart)
  @type = args[:type] if args.key?(:type)
end