Class: Google::Apis::SqlV1beta4::DatabaseInstance

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

Overview

A Cloud SQL instance resource. Next field: 34

Defined Under Namespace

Classes: FailoverReplica

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ DatabaseInstance

Returns a new instance of DatabaseInstance.


643
644
645
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 643

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

Instance Attribute Details

#backend_typeString

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)

476
477
478
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 476

def backend_type
  @backend_type
end

#connection_nameString

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

Returns:

  • (String)

481
482
483
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 481

def connection_name
  @connection_name
end

#current_disk_sizeFixnum

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)

488
489
490
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 488

def current_disk_size
  @current_disk_size
end

#database_versionString

The database engine type and version. The databaseVersion field cannot be changed after instance creation. MySQL instances: 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)

498
499
500
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 498

def database_version
  @database_version
end

#disk_encryption_configurationGoogle::Apis::SqlV1beta4::DiskEncryptionConfiguration

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


503
504
505
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 503

def disk_encryption_configuration
  @disk_encryption_configuration
end

#disk_encryption_statusGoogle::Apis::SqlV1beta4::DiskEncryptionStatus

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


508
509
510
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 508

def disk_encryption_status
  @disk_encryption_status
end

#etagString

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)

514
515
516
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 514

def etag
  @etag
end

#failover_replicaGoogle::Apis::SqlV1beta4::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


520
521
522
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 520

def failover_replica
  @failover_replica
end

#gce_zoneString

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)

527
528
529
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 527

def gce_zone
  @gce_zone
end

#instance_typeString

The instance type. This can be one of the following. CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master. * 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)

535
536
537
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 535

def instance_type
  @instance_type
end

#ip_addressesArray<Google::Apis::SqlV1beta4::IpMapping>

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


540
541
542
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 540

def ip_addresses
  @ip_addresses
end

#ipv6_addressString

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)

546
547
548
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 546

def ipv6_address
  @ipv6_address
end

#kindString

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

Returns:

  • (String)

551
552
553
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 551

def kind
  @kind
end

#master_instance_nameString

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

Returns:

  • (String)

556
557
558
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 556

def master_instance_name
  @master_instance_name
end

#max_disk_sizeFixnum

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

Returns:

  • (Fixnum)

561
562
563
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 561

def max_disk_size
  @max_disk_size
end

#nameString

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

Returns:

  • (String)

566
567
568
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 566

def name
  @name
end

#on_premises_configurationGoogle::Apis::SqlV1beta4::OnPremisesConfiguration

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


571
572
573
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 571

def on_premises_configuration
  @on_premises_configuration
end

#projectString

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)

577
578
579
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 577

def project
  @project
end

#regionString

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)

585
586
587
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 585

def region
  @region
end

#replica_configurationGoogle::Apis::SqlV1beta4::ReplicaConfiguration

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


590
591
592
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 590

def replica_configuration
  @replica_configuration
end

#replica_namesArray<String>

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

Returns:

  • (Array<String>)

595
596
597
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 595

def replica_names
  @replica_names
end

#root_passwordString

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

Returns:

  • (String)

600
601
602
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 600

def root_password
  @root_password
end

#scheduled_maintenanceGoogle::Apis::SqlV1beta4::SqlScheduledMaintenance

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


605
606
607
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 605

def scheduled_maintenance
  @scheduled_maintenance
end

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

Returns:

  • (String)

610
611
612
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 610

def self_link
  @self_link
end

#server_ca_certGoogle::Apis::SqlV1beta4::SslCert

SslCerts Resource Corresponds to the JSON property serverCaCert


615
616
617
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 615

def server_ca_cert
  @server_ca_cert
end

#service_account_email_addressString

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)

621
622
623
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 621

def 
  @service_account_email_address
end

#settingsGoogle::Apis::SqlV1beta4::Settings

Database instance settings. Corresponds to the JSON property settings


626
627
628
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 626

def settings
  @settings
end

#stateString

The current serving state of the Cloud SQL instance. This can be one of the following. RUNNABLE: The instance is running, or is ready to run when accessed. SUSPENDED: The instance is not available, for example due to problems with billing. PENDING_CREATE: The instance is being created. * MAINTENANCE*: The instance is down for maintenance. FAILED: The instance creation failed. UNKNOWN_STATE: The state of the instance is unknown. Corresponds to the JSON property state

Returns:

  • (String)

636
637
638
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 636

def state
  @state
end

#suspension_reasonArray<String>

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

Returns:

  • (Array<String>)

641
642
643
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 641

def suspension_reason
  @suspension_reason
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
# File 'generated/google/apis/sql_v1beta4/classes.rb', line 648

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)
  @scheduled_maintenance = args[:scheduled_maintenance] if args.key?(:scheduled_maintenance)
  @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