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



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

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) 


1848
1849
1850
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1848

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


1854
1855
1856
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1854

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) 


1864
1865
1866
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1864

def availability_type
  @availability_type
end

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

Database instance backup configuration. Corresponds to the JSON property backupConfiguration

Returns:



1869
1870
1871
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1869

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) 


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

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) 


1883
1884
1885
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1883

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) 


1889
1890
1891
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1889

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:



1894
1895
1896
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1894

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) 


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

def database_replication_enabled
  @database_replication_enabled
end

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

IP Management configuration. Corresponds to the JSON property ipConfiguration

Returns:



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

def ip_configuration
  @ip_configuration
end

#kind ⇒ String

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

Returns:

  • (String) 


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

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:



1920
1921
1922
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1920

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:



1926
1927
1928
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1926

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) 


1932
1933
1934
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1932

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) 


1938
1939
1940
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1938

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) 


1946
1947
1948
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1946

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) 


1952
1953
1954
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1952

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) 


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

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) 


1966
1967
1968
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1966

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


1972
1973
1974
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1972

def user_labels
  @user_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 1979

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