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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Settings

Returns a new instance of Settings.



1680
1681
1682
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1680

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. The activation policy cannot be updated together with other settings for Second Generation instances. Valid values: ALWAYS: The instance is on; it is not deactivated by inactivity. NEVER: The instance is off; it is not activated, even if a connection request arrives. ON_DEMAND: The instance responds to incoming requests, and turns itself off when not in use. Instances with PER_USE pricing turn off after 15 minutes of inactivity. Instances with PER_PACKAGE pricing turn off after 12 hours of inactivity. Corresponds to the JSON property activationPolicy

Returns:

  • (String) 


1577
1578
1579
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1577

def activation_policy
  @activation_policy
end

#authorized_gae_applications ⇒ Array<String>

The App Engine app IDs that can access this instance. This property is only applicable to First Generation instances. Corresponds to the JSON property authorizedGaeApplications

Returns:

  • (Array<String>) 


1583
1584
1585
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1583

def authorized_gae_applications
  @authorized_gae_applications
end

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

Database instance backup configuration. Corresponds to the JSON property backupConfiguration

Returns:



1588
1589
1590
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1588

def backup_configuration
  @backup_configuration
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 is only applicable to First Generation instances. Corresponds to the JSON property crashSafeReplicationEnabled

Returns:

  • (Boolean) 


1595
1596
1597
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1595

def crash_safe_replication_enabled
  @crash_safe_replication_enabled
end

#data_disk_size_gb ⇒ String

The size of data disk, in GB. The data disk size minimum is 10GB. Applies only to Second Generation instances. Corresponds to the JSON property dataDiskSizeGb

Returns:

  • (String) 


1602
1603
1604
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1602

def data_disk_size_gb
  @data_disk_size_gb
end

#data_disk_type ⇒ String

The type of data disk. Only supported for Second Generation instances. The default type is PD_SSD. Applies only to Second Generation instances. Corresponds to the JSON property dataDiskType

Returns:

  • (String) 


1608
1609
1610
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1608

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:



1613
1614
1615
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1613

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) 


1619
1620
1621
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1619

def database_replication_enabled
  @database_replication_enabled
end

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

IP Management configuration. Corresponds to the JSON property ipConfiguration

Returns:



1625
1626
1627
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1625

def ip_configuration
  @ip_configuration
end

#kind ⇒ String

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

Returns:

  • (String) 


1630
1631
1632
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1630

def kind
  @kind
end

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

Preferred location. This specifies where a Cloud SQL instance should preferably be 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:



1639
1640
1641
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1639

def location_preference
  @location_preference
end

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

Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance puruposes. Corresponds to the JSON property maintenanceWindow

Returns:



1645
1646
1647
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1645

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) 


1651
1652
1653
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1651

def pricing_plan
  @pricing_plan
end

#replication_type ⇒ String

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

Returns:

  • (String) 


1657
1658
1659
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1657

def replication_type
  @replication_type
end

#settings_version ⇒ String

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:

  • (String) 


1665
1666
1667
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1665

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 false. Applies only to Second Generation instances. Corresponds to the JSON property storageAutoResize

Returns:

  • (Boolean) 


1671
1672
1673
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1671

def storage_auto_resize
  @storage_auto_resize
end

#tier ⇒ String

The tier of service for this instance, for example D1, D2. For more information, see pricing. Corresponds to the JSON property tier

Returns:

  • (String) 


1678
1679
1680
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1678

def tier
  @tier
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1685

def update!(**args)
  @activation_policy = args[:activation_policy] if args.key?(:activation_policy)
  @authorized_gae_applications = args[:authorized_gae_applications] if args.key?(:authorized_gae_applications)
  @backup_configuration = args[:backup_configuration] if args.key?(:backup_configuration)
  @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)
  @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)
  @tier = args[:tier] if args.key?(:tier)
end