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



1731
1732
1733
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1731

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) 


1611
1612
1613
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1611

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


1617
1618
1619
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1617

def authorized_gae_applications
  @authorized_gae_applications
end

#availability_type ⇒ String

Reserved for future use. Corresponds to the JSON property availabilityType

Returns:

  • (String) 


1622
1623
1624
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1622

def availability_type
  @availability_type
end

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

Database instance backup configuration. Corresponds to the JSON property backupConfiguration

Returns:



1627
1628
1629
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1627

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) 


1634
1635
1636
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1634

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

Returns:

  • (Fixnum) 


1641
1642
1643
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1641

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) 


1647
1648
1649
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1647

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:



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

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) 


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

def database_replication_enabled
  @database_replication_enabled
end

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

IP Management configuration. Corresponds to the JSON property ipConfiguration

Returns:



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

def ip_configuration
  @ip_configuration
end

#kind ⇒ String

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

Returns:

  • (String) 


1669
1670
1671
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1669

def kind
  @kind
end

#labels ⇒ Hash<String,String>

User defined labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1674
1675
1676
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1674

def labels
  @labels
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:



1683
1684
1685
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1683

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:



1689
1690
1691
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1689

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) 


1695
1696
1697
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1695

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) 


1701
1702
1703
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1701

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) 


1709
1710
1711
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1709

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

Returns:

  • (Boolean) 


1715
1716
1717
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1715

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

Returns:

  • (Fixnum) 


1723
1724
1725
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1723

def storage_auto_resize_limit
  @storage_auto_resize_limit
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) 


1729
1730
1731
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1729

def tier
  @tier
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1736

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