Class: Google::Apis::SqladminV1::DatabaseInstance

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sqladmin_v1/classes.rb,
lib/google/apis/sqladmin_v1/representations.rb,
lib/google/apis/sqladmin_v1/representations.rb

Overview

A Cloud SQL instance resource.

Defined Under Namespace

Classes: FailoverReplica

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DatabaseInstance

Returns a new instance of DatabaseInstance.



915
916
917
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 915

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#available_maintenance_versions ⇒ Array<String>

Output only. List all maintenance versions applicable on the instance Corresponds to the JSON property availableMaintenanceVersions

Returns:

  • (Array<String>) 


714
715
716
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 714

def available_maintenance_versions
  @available_maintenance_versions
end

#backend_type ⇒ String

The backend type. SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type. Corresponds to the JSON property backendType

Returns:

  • (String) 


721
722
723
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 721

def backend_type
  @backend_type
end

#connection_name ⇒ String

Connection name of the Cloud SQL instance used in connection strings. Corresponds to the JSON property connectionName

Returns:

  • (String) 


726
727
728
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 726

def connection_name
  @connection_name
end

#create_time ⇒ String

Output only. The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. Corresponds to the JSON property createTime

Returns:

  • (String) 


732
733
734
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 732

def create_time
  @create_time
end

#current_disk_size ⇒ Fixnum

The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details. Corresponds to the JSON property currentDiskSize

Returns:

  • (Fixnum) 


741
742
743
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 741

def current_disk_size
  @current_disk_size
end

#database_installed_version ⇒ String

Output only. Stores the current database version running on the instance including minor version such as MYSQL_8_0_18. Corresponds to the JSON property databaseInstalledVersion

Returns:

  • (String) 


747
748
749
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 747

def database_installed_version
  @database_installed_version
end

#database_version ⇒ String

The database engine type and version. The databaseVersion field cannot be changed after instance creation. Corresponds to the JSON property databaseVersion

Returns:

  • (String) 


753
754
755
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 753

def database_version
  @database_version
end

#disk_encryption_configuration ⇒ Google::Apis::SqladminV1::DiskEncryptionConfiguration

Disk encryption configuration for an instance. Corresponds to the JSON property diskEncryptionConfiguration

Returns:



758
759
760
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 758

def disk_encryption_configuration
  @disk_encryption_configuration
end

#disk_encryption_status ⇒ Google::Apis::SqladminV1::DiskEncryptionStatus

Disk encryption status for an instance. Corresponds to the JSON property diskEncryptionStatus

Returns:



763
764
765
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 763

def disk_encryption_status
  @disk_encryption_status
end

#etag ⇒ String

This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead. Corresponds to the JSON property etag

Returns:

  • (String) 


769
770
771
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 769

def etag
  @etag
end

#failover_replica ⇒ Google::Apis::SqladminV1::DatabaseInstance::FailoverReplica

The name and status of the failover replica. Corresponds to the JSON property failoverReplica

Returns:



774
775
776
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 774

def failover_replica
  @failover_replica
end

#gce_zone ⇒ String

The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. Corresponds to the JSON property gceZone

Returns:

  • (String) 


782
783
784
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 782

def gce_zone
  @gce_zone
end

#instance_type ⇒ String

The instance type. Corresponds to the JSON property instanceType

Returns:

  • (String) 


787
788
789
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 787

def instance_type
  @instance_type
end

#ip_addresses ⇒ Array<Google::Apis::SqladminV1::IpMapping>

The assigned IP addresses for the instance. Corresponds to the JSON property ipAddresses

Returns:



792
793
794
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 792

def ip_addresses
  @ip_addresses
end

#ipv6_address ⇒ String

The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. Corresponds to the JSON property ipv6Address

Returns:

  • (String) 


798
799
800
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 798

def ipv6_address
  @ipv6_address
end

#kind ⇒ String

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

Returns:

  • (String) 


803
804
805
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 803

def kind
  @kind
end

#maintenance_version ⇒ String

The current software version on the instance. Corresponds to the JSON property maintenanceVersion

Returns:

  • (String) 


808
809
810
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 808

def maintenance_version
  @maintenance_version
end

#master_instance_name ⇒ String

The name of the instance which will act as primary in the replication setup. Corresponds to the JSON property masterInstanceName

Returns:

  • (String) 


813
814
815
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 813

def master_instance_name
  @master_instance_name
end

#max_disk_size ⇒ Fixnum

The maximum disk size of the instance in bytes. Corresponds to the JSON property maxDiskSize

Returns:

  • (Fixnum) 


818
819
820
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 818

def max_disk_size
  @max_disk_size
end

#name ⇒ String

Name of the Cloud SQL instance. This does not include the project ID. Corresponds to the JSON property name

Returns:

  • (String) 


823
824
825
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 823

def name
  @name
end

#on_premises_configuration ⇒ Google::Apis::SqladminV1::OnPremisesConfiguration

On-premises instance configuration. Corresponds to the JSON property onPremisesConfiguration

Returns:



828
829
830
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 828

def on_premises_configuration
  @on_premises_configuration
end

#out_of_disk_report ⇒ Google::Apis::SqladminV1::SqlOutOfDiskReport

This message wraps up the information written by out-of-disk detection job. Corresponds to the JSON property outOfDiskReport

Returns:



833
834
835
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 833

def out_of_disk_report
  @out_of_disk_report
end

#project ⇒ String

The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. Corresponds to the JSON property project

Returns:

  • (String) 


839
840
841
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 839

def project
  @project
end

#region ⇒ String

The geographical region. Can be: * us-central (FIRST_GEN instances only) * us-central1 (SECOND_GEN instances only) * asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type. The region cannot be changed after instance creation. Corresponds to the JSON property region

Returns:

  • (String) 


847
848
849
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 847

def region
  @region
end

#replica_configuration ⇒ Google::Apis::SqladminV1::ReplicaConfiguration

Read-replica configuration for connecting to the primary instance. Corresponds to the JSON property replicaConfiguration

Returns:



852
853
854
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 852

def replica_configuration
  @replica_configuration
end

#replica_names ⇒ Array<String>

The replicas of the instance. Corresponds to the JSON property replicaNames

Returns:

  • (Array<String>) 


857
858
859
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 857

def replica_names
  @replica_names
end

#root_password ⇒ String

Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. Corresponds to the JSON property rootPassword

Returns:

  • (String) 


863
864
865
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 863

def root_password
  @root_password
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

The status indicating if instance satisfiesPzs. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


868
869
870
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 868

def satisfies_pzs
  @satisfies_pzs
end

#scheduled_maintenance ⇒ Google::Apis::SqladminV1::SqlScheduledMaintenance

Any scheduled maintenance for this instance. Corresponds to the JSON property scheduledMaintenance

Returns:



874
875
876
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 874

def scheduled_maintenance
  @scheduled_maintenance
end

#secondary_gce_zone ⇒ String

The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Corresponds to the JSON property secondaryGceZone

Returns:

  • (String) 


882
883
884
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 882

def secondary_gce_zone
  @secondary_gce_zone
end

#self_link ⇒ String

The URI of this resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


887
888
889
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 887

def self_link
  @self_link
end

#server_ca_cert ⇒ Google::Apis::SqladminV1::SslCert

SslCerts Resource Corresponds to the JSON property serverCaCert

Returns:



892
893
894
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 892

def server_ca_cert
  @server_ca_cert
end

#service_account_email_address ⇒ String

The service account email address assigned to the instance.\This property is read-only. Corresponds to the JSON property serviceAccountEmailAddress

Returns:

  • (String) 


898
899
900
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 898

def 
  @service_account_email_address
end

#settings ⇒ Google::Apis::SqladminV1::Settings

Database instance settings. Corresponds to the JSON property settings

Returns:



903
904
905
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 903

def settings
  @settings
end

#state ⇒ String

The current serving state of the Cloud SQL instance. Corresponds to the JSON property state

Returns:

  • (String) 


908
909
910
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 908

def state
  @state
end

#suspension_reason ⇒ Array<String>

If the instance state is SUSPENDED, the reason for the suspension. Corresponds to the JSON property suspensionReason

Returns:

  • (Array<String>) 


913
914
915
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 913

def suspension_reason
  @suspension_reason
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 920

def update!(**args)
  @available_maintenance_versions = args[:available_maintenance_versions] if args.key?(:available_maintenance_versions)
  @backend_type = args[:backend_type] if args.key?(:backend_type)
  @connection_name = args[:connection_name] if args.key?(:connection_name)
  @create_time = args[:create_time] if args.key?(:create_time)
  @current_disk_size = args[:current_disk_size] if args.key?(:current_disk_size)
  @database_installed_version = args[:database_installed_version] if args.key?(:database_installed_version)
  @database_version = args[:database_version] if args.key?(:database_version)
  @disk_encryption_configuration = args[:disk_encryption_configuration] if args.key?(:disk_encryption_configuration)
  @disk_encryption_status = args[:disk_encryption_status] if args.key?(:disk_encryption_status)
  @etag = args[:etag] if args.key?(:etag)
  @failover_replica = args[:failover_replica] if args.key?(:failover_replica)
  @gce_zone = args[:gce_zone] if args.key?(:gce_zone)
  @instance_type = args[:instance_type] if args.key?(:instance_type)
  @ip_addresses = args[:ip_addresses] if args.key?(:ip_addresses)
  @ipv6_address = args[:ipv6_address] if args.key?(:ipv6_address)
  @kind = args[:kind] if args.key?(:kind)
  @maintenance_version = args[:maintenance_version] if args.key?(:maintenance_version)
  @master_instance_name = args[:master_instance_name] if args.key?(:master_instance_name)
  @max_disk_size = args[:max_disk_size] if args.key?(:max_disk_size)
  @name = args[:name] if args.key?(:name)
  @on_premises_configuration = args[:on_premises_configuration] if args.key?(:on_premises_configuration)
  @out_of_disk_report = args[:out_of_disk_report] if args.key?(:out_of_disk_report)
  @project = args[:project] if args.key?(:project)
  @region = args[:region] if args.key?(:region)
  @replica_configuration = args[:replica_configuration] if args.key?(:replica_configuration)
  @replica_names = args[:replica_names] if args.key?(:replica_names)
  @root_password = args[:root_password] if args.key?(:root_password)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @scheduled_maintenance = args[:scheduled_maintenance] if args.key?(:scheduled_maintenance)
  @secondary_gce_zone = args[:secondary_gce_zone] if args.key?(:secondary_gce_zone)
  @self_link = args[:self_link] if args.key?(:self_link)
  @server_ca_cert = args[:server_ca_cert] if args.key?(:server_ca_cert)
  @service_account_email_address = args[:service_account_email_address] if args.key?(:service_account_email_address)
  @settings = args[:settings] if args.key?(:settings)
  @state = args[:state] if args.key?(:state)
  @suspension_reason = args[:suspension_reason] if args.key?(:suspension_reason)
end