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.



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

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

Instance Attribute Details

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


611
612
613
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 611

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) 


616
617
618
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 616

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) 


622
623
624
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 622

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) 


631
632
633
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 631

def current_disk_size
  @current_disk_size
end

#database_version ⇒ String

The database engine type and version. The databaseVersion field cannot be changed after instance creation. * MySQL instances: MYSQL_8_0, MYSQL_5_7 ( default), or MYSQL_5_6. * PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13 (default), POSTGRES_14. * SQL Server instances: SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB, SQLSERVER_2017_STANDARD ( default), SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, or SQLSERVER_2017_WEB. Corresponds to the JSON property databaseVersion

Returns:

  • (String) 


643
644
645
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 643

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:



648
649
650
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 648

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:



653
654
655
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 653

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) 


659
660
661
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 659

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:



664
665
666
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 664

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. Corresponds to the JSON property gceZone

Returns:

  • (String) 


671
672
673
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 671

def gce_zone
  @gce_zone
end

#instance_type ⇒ String

The instance type. This can be one of the following: * CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a primary instance. * ** ON_PREMISES_INSTANCE*: An instance running on the customer's premises. * * READ_REPLICA_INSTANCE**: A Cloud SQL instance configured as a read-replica. Corresponds to the JSON property instanceType

Returns:

  • (String) 


679
680
681
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 679

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:



684
685
686
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 684

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) 


690
691
692
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 690

def ipv6_address
  @ipv6_address
end

#kind ⇒ String

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

Returns:

  • (String) 


695
696
697
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 695

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


700
701
702
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 700

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) 


705
706
707
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 705

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) 


710
711
712
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 710

def name
  @name
end

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

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

Returns:



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

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:



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

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) 


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

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) 


734
735
736
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 734

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:



739
740
741
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 739

def replica_configuration
  @replica_configuration
end

#replica_names ⇒ Array<String>

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

Returns:

  • (Array<String>) 


744
745
746
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 744

def replica_names
  @replica_names
end

#root_password ⇒ String

Initial root password. Use only on creation. Corresponds to the JSON property rootPassword

Returns:

  • (String) 


749
750
751
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 749

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) 


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

def satisfies_pzs
  @satisfies_pzs
end

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

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

Returns:



760
761
762
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 760

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. Reserved for future use. Corresponds to the JSON property secondaryGceZone

Returns:

  • (String) 


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

def secondary_gce_zone
  @secondary_gce_zone
end

#self_link ⇒ String

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

Returns:

  • (String) 


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

def self_link
  @self_link
end

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

SslCerts Resource Corresponds to the JSON property serverCaCert

Returns:



778
779
780
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 778

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) 


784
785
786
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 784

def 
  @service_account_email_address
end

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

Database instance settings. Corresponds to the JSON property settings

Returns:



789
790
791
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 789

def settings
  @settings
end

#state ⇒ String

The current serving state of the Cloud SQL instance. This can be one of the following: * SQL_INSTANCE_STATE_UNSPECIFIED: The state of the instance is unknown. * RUNNABLE: The instance is running, or has been stopped by owner.

  • SUSPENDED: The instance is not available, for example due to problems with billing. * PENDING_DELETE: The instance is being deleted. * ** PENDING_CREATE*: The instance is being created. * **MAINTENANCE: The instance is down for maintenance. * **FAILED*: The instance creation failed. Corresponds to the JSON property state

Returns:

  • (String) 


800
801
802
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 800

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


805
806
807
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 805

def suspension_reason
  @suspension_reason
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 812

def update!(**args)
  @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_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)
  @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