Class: Google::Apis::SqladminV1beta4::Settings

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

Overview

Database instance settings.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Settings

Returns a new instance of Settings.



2515
2516
2517
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2515

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

Instance Attribute Details

#activation_policy ⇒ String

The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: ALWAYS: The instance is on, and remains so even in the absence of connection requests. NEVER: The instance is off; it is not activated, even if a connection request arrives. Corresponds to the JSON property activationPolicy

Returns:

  • (String) 


2370
2371
2372
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2370

def activation_policy
  @activation_policy
end

#active_directory_config ⇒ Google::Apis::SqladminV1beta4::SqlActiveDirectoryConfig

Active Directory configuration, relevant only for Cloud SQL for SQL Server. Corresponds to the JSON property activeDirectoryConfig

Returns:



2375
2376
2377
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2375

def active_directory_config
  @active_directory_config
end

#authorized_gae_applications ⇒ Array<String>

The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only. Corresponds to the JSON property authorizedGaeApplications

Returns:

  • (Array<String>) 


2381
2382
2383
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2381

def authorized_gae_applications
  @authorized_gae_applications
end

#availability_type ⇒ String

Availability type. Potential values: ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility. REGIONAL: The instance can serve data from more than one zone in a region (it is highly available). For more information, see Overview of the High Availability Configuration. Corresponds to the JSON property availabilityType

Returns:

  • (String) 


2390
2391
2392
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2390

def availability_type
  @availability_type
end

#backup_configuration ⇒ Google::Apis::SqladminV1beta4::BackupConfiguration

Database instance backup configuration. Corresponds to the JSON property backupConfiguration

Returns:



2395
2396
2397
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2395

def backup_configuration
  @backup_configuration
end

#collation ⇒ String

The name of server Instance collation. Corresponds to the JSON property collation

Returns:

  • (String) 


2400
2401
2402
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2400

def collation
  @collation
end

#crash_safe_replication_enabled ⇒ Boolean Also known as: crash_safe_replication_enabled?

Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances. Corresponds to the JSON property crashSafeReplicationEnabled

Returns:

  • (Boolean) 


2407
2408
2409
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2407

def crash_safe_replication_enabled
  @crash_safe_replication_enabled
end

#data_disk_size_gb ⇒ Fixnum

The size of data disk, in GB. The data disk size minimum is 10GB. Corresponds to the JSON property dataDiskSizeGb

Returns:

  • (Fixnum) 


2413
2414
2415
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2413

def data_disk_size_gb
  @data_disk_size_gb
end

#data_disk_type ⇒ String

The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances. Corresponds to the JSON property dataDiskType

Returns:

  • (String) 


2419
2420
2421
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2419

def data_disk_type
  @data_disk_type
end

#database_flags ⇒ Array<Google::Apis::SqladminV1beta4::DatabaseFlags>

The database flags passed to the instance at startup. Corresponds to the JSON property databaseFlags

Returns:



2424
2425
2426
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2424

def database_flags
  @database_flags
end

#database_replication_enabled ⇒ Boolean Also known as: database_replication_enabled?

Configuration specific to read replica instances. Indicates whether replication is enabled or not. Corresponds to the JSON property databaseReplicationEnabled

Returns:

  • (Boolean) 


2430
2431
2432
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2430

def database_replication_enabled
  @database_replication_enabled
end

#deny_maintenance_periods ⇒ Array<Google::Apis::SqladminV1beta4::DenyMaintenancePeriod>

Deny maintenance periods Corresponds to the JSON property denyMaintenancePeriods

Returns:



2436
2437
2438
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2436

def deny_maintenance_periods
  @deny_maintenance_periods
end

#insights_config ⇒ Google::Apis::SqladminV1beta4::InsightsConfig

Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. Corresponds to the JSON property insightsConfig

Returns:



2442
2443
2444
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2442

def insights_config
  @insights_config
end

#ip_configuration ⇒ Google::Apis::SqladminV1beta4::IpConfiguration

IP Management configuration. Corresponds to the JSON property ipConfiguration

Returns:



2447
2448
2449
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2447

def ip_configuration
  @ip_configuration
end

#kind ⇒ String

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

Returns:

  • (String) 


2452
2453
2454
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2452

def kind
  @kind
end

#location_preference ⇒ Google::Apis::SqladminV1beta4::LocationPreference

Preferred location. This specifies where a Cloud SQL instance is located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. Corresponds to the JSON property locationPreference

Returns:



2461
2462
2463
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2461

def location_preference
  @location_preference
end

#maintenance_window ⇒ Google::Apis::SqladminV1beta4::MaintenanceWindow

Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. Corresponds to the JSON property maintenanceWindow

Returns:



2467
2468
2469
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2467

def maintenance_window
  @maintenance_window
end

#pricing_plan ⇒ String

The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances. Corresponds to the JSON property pricingPlan

Returns:

  • (String) 


2473
2474
2475
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2473

def pricing_plan
  @pricing_plan
end

#replication_type ⇒ String

The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. (Deprecated_ This property was only applicable to First Generation instances. Corresponds to the JSON property replicationType

Returns:

  • (String) 


2480
2481
2482
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2480

def replication_type
  @replication_type
end

#settings_version ⇒ Fixnum

The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. Corresponds to the JSON property settingsVersion

Returns:

  • (Fixnum) 


2488
2489
2490
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2488

def settings_version
  @settings_version
end

#storage_auto_resize ⇒ Boolean Also known as: storage_auto_resize?

Configuration to increase storage size automatically. The default value is true. Corresponds to the JSON property storageAutoResize

Returns:

  • (Boolean) 


2494
2495
2496
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2494

def storage_auto_resize
  @storage_auto_resize
end

#storage_auto_resize_limit ⇒ Fixnum

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. Corresponds to the JSON property storageAutoResizeLimit

Returns:

  • (Fixnum) 


2501
2502
2503
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2501

def storage_auto_resize_limit
  @storage_auto_resize_limit
end

#tier ⇒ String

The tier (or machine type) for this instance, for example db-n1-standard-1 ( MySQL instances) or db-custom-1-3840 (PostgreSQL instances). Corresponds to the JSON property tier

Returns:

  • (String) 


2507
2508
2509
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2507

def tier
  @tier
end

#user_labels ⇒ Hash<String,String>

User-provided labels, represented as a dictionary where each label is a single key value pair. Corresponds to the JSON property userLabels

Returns:

  • (Hash<String,String>) 


2513
2514
2515
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2513

def user_labels
  @user_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2520

def update!(**args)
  @activation_policy = args[:activation_policy] if args.key?(:activation_policy)
  @active_directory_config = args[:active_directory_config] if args.key?(:active_directory_config)
  @authorized_gae_applications = args[:authorized_gae_applications] if args.key?(:authorized_gae_applications)
  @availability_type = args[:availability_type] if args.key?(:availability_type)
  @backup_configuration = args[:backup_configuration] if args.key?(:backup_configuration)
  @collation = args[:collation] if args.key?(:collation)
  @crash_safe_replication_enabled = args[:crash_safe_replication_enabled] if args.key?(:crash_safe_replication_enabled)
  @data_disk_size_gb = args[:data_disk_size_gb] if args.key?(:data_disk_size_gb)
  @data_disk_type = args[:data_disk_type] if args.key?(:data_disk_type)
  @database_flags = args[:database_flags] if args.key?(:database_flags)
  @database_replication_enabled = args[:database_replication_enabled] if args.key?(:database_replication_enabled)
  @deny_maintenance_periods = args[:deny_maintenance_periods] if args.key?(:deny_maintenance_periods)
  @insights_config = args[:insights_config] if args.key?(:insights_config)
  @ip_configuration = args[:ip_configuration] if args.key?(:ip_configuration)
  @kind = args[:kind] if args.key?(:kind)
  @location_preference = args[:location_preference] if args.key?(:location_preference)
  @maintenance_window = args[:maintenance_window] if args.key?(:maintenance_window)
  @pricing_plan = args[:pricing_plan] if args.key?(:pricing_plan)
  @replication_type = args[:replication_type] if args.key?(:replication_type)
  @settings_version = args[:settings_version] if args.key?(:settings_version)
  @storage_auto_resize = args[:storage_auto_resize] if args.key?(:storage_auto_resize)
  @storage_auto_resize_limit = args[:storage_auto_resize_limit] if args.key?(:storage_auto_resize_limit)
  @tier = args[:tier] if args.key?(:tier)
  @user_labels = args[:user_labels] if args.key?(:user_labels)
end