class Fog::Google::SQL::Instance
Constants
- MAINTENANCE_STATE
- PENDING_CREATE_STATE
- RUNNABLE_STATE
- SUSPENDED_STATE
- UNKNOWN_STATE
Public Instance Methods
Returns the activation policy for this instance
@return [String] The activation policy for this instance
# File lib/fog/google/models/sql/instance.rb, line 46 def activation_policy settings["activationPolicy"] end
Returns the AppEngine app ids that can access this instance
@return [Array<String>] The AppEngine app ids that can access this instance
# File lib/fog/google/models/sql/instance.rb, line 54 def autorized_gae_applications settings["authorizedGaeApplications"] end
Returns the daily backup configuration for the instance
@return [Array<Hash>] The daily backup configuration for the instance
# File lib/fog/google/models/sql/instance.rb, line 62 def backup_configuration settings["backupConfiguration"] end
Creates a Cloud SQL instance as a clone of the source instance
@param [String] destination_name Name of the Cloud SQL instance to be created as a clone @param [Hash] options Method options @option options [String] :log_filename Name of the binary log file for a Cloud SQL instance @option options [Integer] :log_position Position (offset) within the binary log file @option options [Boolean] :async If the operation must be performed asynchronously (true by default) @return [Fog::Google::SQL::Operation] A Operation resource
# File lib/fog/google/models/sql/instance.rb, line 75 def clone(destination_name, options = {}) requires :identity data = service.clone_instance(identity, destination_name, options) operation = Fog::Google::SQL::Operations.new(:service => service).get(instance, data.body["operation"]) operation.wait_for { ready? } unless options.fetch(:async, true) operation end
Creates a Cloud SQL instance
@return [Fog::Google::SQL::Instance] Instance resource
# File lib/fog/google/models/sql/instance.rb, line 88 def create requires :identity data = service.insert_instance(identity, attributes[:tier], attributes) operation = Fog::Google::SQL::Operations.new(:service => service).get(instance, data.body["operation"]) operation.wait_for { !pending? } reload end
Returns the database flags passed to the instance at startup
@return [Array<Hash>] The database flags passed to the instance at startup
# File lib/fog/google/models/sql/instance.rb, line 101 def database_flags settings["databaseFlags"] end
Deletes a Cloud SQL instance
@param [Hash] options Method options @option options [Boolean] :async If the operation must be performed asynchronously (true by default) @return [Fog::Google::SQL::Operation] A Operation resource
# File lib/fog/google/models/sql/instance.rb, line 111 def destroy(options = {}) requires :identity data = service.delete_instance(identity) operation = Fog::Google::SQL::Operations.new(:service => service).get(instance, data.body["operation"]) unless options.fetch(:async, true) # DISABLED: A delete instance operation never reachs a 'DONE' state (bug?) # operation.wait_for { ready? } end operation end
Exports data from a Cloud SQL instance to a Google Cloud Storage bucket as a MySQL dump file
@param [String] uri The path to the file in Google Cloud Storage where the export will be stored,
or where it was already stored
@param [Hash] options Method options @option options [Array<String>] :databases Databases (for example, guestbook) from which the export is made.
If unspecified, all databases are exported.
@option options [Array<String>] :tables Tables to export, or that were exported, from the specified database.
If you specify tables, specify one and only one database.
@option options [Boolean] :async If the operation must be performed asynchronously (true by default) @return [Fog::Google::SQL::Operation] A Operation resource
# File lib/fog/google/models/sql/instance.rb, line 135 def export(uri, options = {}) requires :identity data = service.export_instance(identity, uri, options) operation = Fog::Google::SQL::Operations.new(:service => service).get(instance, data.body["operation"]) operation.wait_for { ready? } unless options.fetch(:async, true) operation end
Imports data into a Cloud SQL instance from a MySQL dump file in Google Cloud Storage
@param [Array<String>] uri A path to the MySQL dump file in Google Cloud Storage from which the import is
made
@param [Hash] options Method options @option options [String] :database The database (for example, guestbook) to which the import is made.
If not set, it is assumed that the database is specified in the file to be imported.
@option options [Boolean] :async If the operation must be performed asynchronously (true by default) @return [Fog::Google::SQL::Operation] A Operation resource
# File lib/fog/google/models/sql/instance.rb, line 154 def import(uri, options = {}) requires :identity data = service.import_instance(identity, uri, options) operation = Fog::Google::SQL::Operations.new(:service => service).get(instance, data.body["operation"]) operation.wait_for { ready? } unless options.fetch(:async, true) operation end
Returns whether the instance should be assigned an IP address or not
@return [Boolean] Whether the instance should be assigned an IP address or not
# File lib/fog/google/models/sql/instance.rb, line 175 def ip_configuration_enabled settings.fetch("ipConfiguration", {})["enabled"] end
Returns whether the mysqld should default to 'REQUIRE X509' for users connecting over IP
@return [Boolean] Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP
# File lib/fog/google/models/sql/instance.rb, line 183 def ip_configuration_require_ssl settings.fetch("ipConfiguration", {})["requireSsl"] end
Returns the AppEngine application to follow
@return [String] The AppEngine application to follow
# File lib/fog/google/models/sql/instance.rb, line 191 def location_preference_zone_follow_gae_application settings.fetch("locationPreference", {})["followGaeApplication"] end
Returns the pricing plan for this instance
@return [String] The pricing plan for this instance
# File lib/fog/google/models/sql/instance.rb, line 207 def pricing_plan settings["pricingPlan"] end
Checks if the instance is running
@return [Boolean] True if the instance is running; False otherwise
# File lib/fog/google/models/sql/instance.rb, line 215 def ready? state == RUNNABLE_STATE end
Returns the type of replication this instance uses
@return [String] The type of replication this instance uses
# File lib/fog/google/models/sql/instance.rb, line 223 def replication_type settings["replicationType"] end
Deletes all client certificates and generates a new server SSL certificate for the instance
@param [Hash] options Method options @option options [Boolean] :async If the operation must be performed asynchronously (true by default) @return [Fog::Google::SQL::Operation] A Operation resource
# File lib/fog/google/models/sql/instance.rb, line 233 def reset_ssl_config(options = {}) requires :identity data = service.reset_instance_ssl_config(identity) operation = Fog::Google::SQL::Operations.new(:service => service).get(instance, data.body["operation"]) operation.wait_for { ready? } unless options.fetch(:async, true) operation end
Restarts a Cloud SQL instance
@param [Hash] options Method options @option options [Boolean] :async If the operation must be performed asynchronously (true by default) @return [Fog::Google::SQL::Operation] A Operation resource
# File lib/fog/google/models/sql/instance.rb, line 248 def restart(options = {}) requires :identity data = service.restart_instance(identity) operation = Fog::Google::SQL::Operations.new(:service => service).get(instance, data.body["operation"]) operation.wait_for { ready? } unless options.fetch(:async, true) operation end
Restores a backup of a Cloud SQL instance
@param [String] #backup_configuration The identifier of the backup configuration @param [String] due_time The time when this run is due to start in RFC 3339 format @param [Hash] options Method options @option options [Boolean] :async If the operation must be performed asynchronously (true by default) @return [Fog::Google::SQL::Operation] A Operation resource
# File lib/fog/google/models/sql/instance.rb, line 265 def restore_backup(backup_configuration, due_time, options = {}) requires :identity data = service.restore_instance_backup(identity, backup_configuration, due_time) operation = Fog::Google::SQL::Operations.new(:service => service).get(instance, data.body["operation"]) operation.wait_for { ready? } unless options.fetch(:async, true) operation end
Sets the password for the root user
@param [String] password The password for the root user @param [Hash] options Method options @option options [Boolean] :async If the operation must be performed asynchronously (true by default) @return [Fog::Google::SQL::Operation] A Operation resource
# File lib/fog/google/models/sql/instance.rb, line 289 def set_root_password(password, options = {}) requires :identity data = service.set_instance_root_password(identity, password) operation = Fog::Google::SQL::Operations.new(:service => service).get(instance, data.body["operation"]) operation.wait_for { ready? } unless options.fetch(:async, true) operation end
Returns the version of instance settings
@return [String] The version of instance settings
# File lib/fog/google/models/sql/instance.rb, line 302 def settings_version settings["settingsVersion"] end
Lists all of the current SSL certificates for the instance
@return [Array<Fog::Google::SQL::SslCert>] List of SSL certificate resources
# File lib/fog/google/models/sql/instance.rb, line 310 def ssl_certs requires :identity service.ssl_certs.all(identity) end
Returns the tier of service for this instance
@return [String] The tier of service for this instance
# File lib/fog/google/models/sql/instance.rb, line 320 def tier settings["tier"] end
Updates settings of a Cloud SQL instance
@return [Fog::Google::SQL::Instance] Instance resource
# File lib/fog/google/models/sql/instance.rb, line 328 def update requires :identity data = service.update_instance(identity, settings_version, tier, attributes) operation = Fog::Google::SQL::Operations.new(:service => service).get(instance, data.body["operation"]) operation.wait_for { !pending? } reload end