Class: Google::Apis::SqladminV1beta4::Settings
- Inherits:
-
Object
- Object
- Google::Apis::SqladminV1beta4::Settings
- 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
-
#activation_policy ⇒ String
The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE.
-
#authorized_gae_applications ⇒ Array<String>
The App Engine app IDs that can access this instance.
-
#availability_type ⇒ String
Availability type (PostgreSQL instances only).
-
#backup_configuration ⇒ Google::Apis::SqladminV1beta4::BackupConfiguration
Database instance backup configuration.
-
#crash_safe_replication_enabled ⇒ Boolean
(also: #crash_safe_replication_enabled?)
Configuration specific to read replica instances.
-
#data_disk_size_gb ⇒ Fixnum
The size of data disk, in GB.
-
#data_disk_type ⇒ String
The type of data disk: PD_SSD (default) or PD_HDD.
-
#database_flags ⇒ Array<Google::Apis::SqladminV1beta4::DatabaseFlags>
The database flags passed to the instance at startup.
-
#database_replication_enabled ⇒ Boolean
(also: #database_replication_enabled?)
Configuration specific to read replica instances.
-
#ip_configuration ⇒ Google::Apis::SqladminV1beta4::IpConfiguration
IP Management configuration.
-
#kind ⇒ String
This is always sql#settings.
-
#location_preference ⇒ Google::Apis::SqladminV1beta4::LocationPreference
Preferred location.
-
#maintenance_window ⇒ Google::Apis::SqladminV1beta4::MaintenanceWindow
Maintenance window.
-
#pricing_plan ⇒ String
The pricing plan for this instance.
-
#replication_type ⇒ String
The type of replication this instance uses.
-
#settings_version ⇒ Fixnum
The version of instance settings.
-
#storage_auto_resize ⇒ Boolean
(also: #storage_auto_resize?)
Configuration to increase storage size automatically.
-
#storage_auto_resize_limit ⇒ Fixnum
The maximum size to which storage capacity can be automatically increased.
-
#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).
-
#user_labels ⇒ Hash<String,String>
User-provided labels, represented as a dictionary where each label is a single key value pair.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Settings
constructor
A new instance of Settings.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Settings
Returns a new instance of Settings
2144 2145 2146 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2144 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
2016 2017 2018 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2016 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
2022 2023 2024 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2022 def @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
2032 2033 2034 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2032 def availability_type @availability_type end |
#backup_configuration ⇒ Google::Apis::SqladminV1beta4::BackupConfiguration
Database instance backup configuration.
Corresponds to the JSON property backupConfiguration
2037 2038 2039 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2037 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
2044 2045 2046 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2044 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
2051 2052 2053 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2051 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
2057 2058 2059 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2057 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
2062 2063 2064 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2062 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
2068 2069 2070 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2068 def database_replication_enabled @database_replication_enabled end |
#ip_configuration ⇒ Google::Apis::SqladminV1beta4::IpConfiguration
IP Management configuration.
Corresponds to the JSON property ipConfiguration
2074 2075 2076 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2074 def ip_configuration @ip_configuration end |
#kind ⇒ String
This is always sql#settings.
Corresponds to the JSON property kind
2079 2080 2081 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2079 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
2088 2089 2090 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2088 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 purposes.
Corresponds to the JSON property maintenanceWindow
2094 2095 2096 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2094 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
2100 2101 2102 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2100 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
2106 2107 2108 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2106 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
2114 2115 2116 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2114 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
2120 2121 2122 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2120 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
2128 2129 2130 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2128 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
2136 2137 2138 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2136 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
2142 2143 2144 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2142 def user_labels @user_labels end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 2149 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 |