Class: Google::Apis::SqladminV1beta4::DatabaseInstance

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

A Cloud SQL instance resource. Next field: 36

Defined Under Namespace

Classes: FailoverReplica

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DatabaseInstance

Returns a new instance of DatabaseInstance.



727
728
729
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 727

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

Instance Attribute Details

#backend_type ⇒ String

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) 


543
544
545
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 543

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) 


548
549
550
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 548

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


555
556
557
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 555

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 or POSTGRES_12 (default). SQL Server instances: * SQLSERVER_2017_STANDARD* (default), SQLSERVER_2017_ENTERPRISE, * SQLSERVER_2017_EXPRESS*, or SQLSERVER_2017_WEB. Corresponds to the JSON property databaseVersion

Returns:

  • (String) 


565
566
567
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 565

def database_version
  @database_version
end

#disk_encryption_configuration ⇒ Google::Apis::SqladminV1beta4::DiskEncryptionConfiguration

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

Returns:



570
571
572
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 570

def disk_encryption_configuration
  @disk_encryption_configuration
end

#disk_encryption_status ⇒ Google::Apis::SqladminV1beta4::DiskEncryptionStatus

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

Returns:



575
576
577
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 575

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) 


581
582
583
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 581

def etag
  @etag
end

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

The name and status of the failover replica. This property is applicable only to Second Generation instances. Corresponds to the JSON property failoverReplica

Returns:



587
588
589
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 587

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) 


594
595
596
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 594

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) 


602
603
604
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 602

def instance_type
  @instance_type
end

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

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

Returns:



607
608
609
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 607

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) 


613
614
615
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 613

def ipv6_address
  @ipv6_address
end

#kind ⇒ String

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

Returns:

  • (String) 


618
619
620
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 618

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) 


623
624
625
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 623

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) 


628
629
630
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 628

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) 


633
634
635
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 633

def name
  @name
end

#on_premises_configuration ⇒ Google::Apis::SqladminV1beta4::OnPremisesConfiguration

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

Returns:



638
639
640
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 638

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


644
645
646
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 644

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) 


652
653
654
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 652

def region
  @region
end

#replica_configuration ⇒ Google::Apis::SqladminV1beta4::ReplicaConfiguration

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

Returns:



657
658
659
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 657

def replica_configuration
  @replica_configuration
end

#replica_names ⇒ Array<String>

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

Returns:

  • (Array<String>) 


662
663
664
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 662

def replica_names
  @replica_names
end

#root_password ⇒ String

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

Returns:

  • (String) 


667
668
669
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 667

def root_password
  @root_password
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


673
674
675
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 673

def satisfies_pzs
  @satisfies_pzs
end

#scheduled_maintenance ⇒ Google::Apis::SqladminV1beta4::SqlScheduledMaintenance

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

Returns:



679
680
681
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 679

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) 


687
688
689
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 687

def secondary_gce_zone
  @secondary_gce_zone
end

#self_link ⇒ String

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

Returns:

  • (String) 


692
693
694
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 692

def self_link
  @self_link
end

#server_ca_cert ⇒ Google::Apis::SqladminV1beta4::SslCert

SslCerts Resource Corresponds to the JSON property serverCaCert

Returns:



697
698
699
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 697

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 applicable only to Second Generation instances. Corresponds to the JSON property serviceAccountEmailAddress

Returns:

  • (String) 


703
704
705
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 703

def 
  @service_account_email_address
end

#settings ⇒ Google::Apis::SqladminV1beta4::Settings

Database instance settings. Corresponds to the JSON property settings

Returns:



708
709
710
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 708

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 has been stopped by owner. It is not currently running, but it's ready to be restarted. SUSPENDED: The instance is not available, for example due to problems with billing. 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) 


720
721
722
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 720

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


725
726
727
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 725

def suspension_reason
  @suspension_reason
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
 
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 732

def update!(**args)
  @backend_type = args[:backend_type] if args.key?(:backend_type)
  @connection_name = args[:connection_name] if args.key?(:connection_name)
  @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)
  @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