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



1999
2000
2001
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1999

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. ON_DEMAND: First Generation instances only. 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) 


1871
1872
1873
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1871

def activation_policy
  @activation_policy
end

#authorized_gae_applications ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1877
1878
1879
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1877

def authorized_gae_applications
  @authorized_gae_applications
end

#availability_type ⇒ String

Availability type (PostgreSQL instances only). 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) 


1887
1888
1889
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1887

def availability_type
  @availability_type
end

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

Database instance backup configuration. Corresponds to the JSON property backupConfiguration

Returns:



1892
1893
1894
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1892

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) 


1899
1900
1901
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1899

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. Not used for First Generation instances. Corresponds to the JSON property dataDiskSizeGb

Returns:

  • (Fixnum) 


1906
1907
1908
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1906

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) 


1912
1913
1914
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1912

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:



1917
1918
1919
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1917

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) 


1923
1924
1925
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1923

def database_replication_enabled
  @database_replication_enabled
end

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

IP Management configuration. Corresponds to the JSON property ipConfiguration

Returns:



1929
1930
1931
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1929

def ip_configuration
  @ip_configuration
end

#kind ⇒ String

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

Returns:

  • (String) 


1934
1935
1936
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1934

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:



1943
1944
1945
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1943

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:



1949
1950
1951
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1949

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) 


1955
1956
1957
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1955

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) 


1961
1962
1963
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1961

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) 


1969
1970
1971
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1969

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. Not used for First Generation instances. Corresponds to the JSON property storageAutoResize

Returns:

  • (Boolean) 


1975
1976
1977
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1975

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. Not used for First Generation instances. Corresponds to the JSON property storageAutoResizeLimit

Returns:

  • (Fixnum) 


1983
1984
1985
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1983

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). For MySQL instances, this property determines whether the instance is First or Second Generation. For more information, see Instance Settings. Corresponds to the JSON property tier

Returns:

  • (String) 


1991
1992
1993
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1991

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


1997
1998
1999
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1997

def user_labels
  @user_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2004

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