Class: Google::Apis::SqladminV1beta4::DatabaseInstance
- Inherits:
-
Object
- Object
- Google::Apis::SqladminV1beta4::DatabaseInstance
- 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.
Defined Under Namespace
Classes: FailoverReplica
Instance Attribute Summary collapse
-
#backend_type ⇒ String
FIRST_GEN: First Generation instance.
-
#connection_name ⇒ String
Connection name of the Cloud SQL instance used in connection strings.
-
#current_disk_size ⇒ Fixnum
The current disk usage of the instance in bytes.
-
#database_version ⇒ String
The database engine type and version.
-
#disk_encryption_configuration ⇒ Google::Apis::SqladminV1beta4::DiskEncryptionConfiguration
Disk encryption configuration.
-
#disk_encryption_status ⇒ Google::Apis::SqladminV1beta4::DiskEncryptionStatus
Disk encryption status.
-
#etag ⇒ String
This field is deprecated and will be removed from a future version of the API.
-
#failover_replica ⇒ Google::Apis::SqladminV1beta4::DatabaseInstance::FailoverReplica
The name and status of the failover replica.
-
#gce_zone ⇒ String
The Compute Engine zone that the instance is currently serving from.
-
#instance_type ⇒ String
The instance type.
-
#ip_addresses ⇒ Array<Google::Apis::SqladminV1beta4::IpMapping>
The assigned IP addresses for the instance.
-
#ipv6_address ⇒ String
The IPv6 address assigned to the instance.
-
#kind ⇒ String
This is always sql#instance.
-
#master_instance_name ⇒ String
The name of the instance which will act as master in the replication setup.
-
#max_disk_size ⇒ Fixnum
The maximum disk size of the instance in bytes.
-
#name ⇒ String
Name of the Cloud SQL instance.
-
#on_premises_configuration ⇒ Google::Apis::SqladminV1beta4::OnPremisesConfiguration
On-premises instance configuration.
-
#project ⇒ String
The project ID of the project containing the Cloud SQL instance.
-
#region ⇒ String
The geographical region.
-
#replica_configuration ⇒ Google::Apis::SqladminV1beta4::ReplicaConfiguration
Read-replica configuration for connecting to the master.
-
#replica_names ⇒ Array<String>
The replicas of the instance.
-
#root_password ⇒ String
Initial root password.
-
#self_link ⇒ String
The URI of this resource.
-
#server_ca_cert ⇒ Google::Apis::SqladminV1beta4::SslCert
SslCerts Resource Corresponds to the JSON property
serverCaCert
. -
#service_account_email_address ⇒ String
The service account email address assigned to the instance.
-
#settings ⇒ Google::Apis::SqladminV1beta4::Settings
Database instance settings.
-
#state ⇒ String
The current serving state of the Cloud SQL instance.
-
#suspension_reason ⇒ Array<String>
If the instance state is SUSPENDED, the reason for the suspension.
Instance Method Summary collapse
-
#initialize(**args) ⇒ DatabaseInstance
constructor
A new instance of DatabaseInstance.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ DatabaseInstance
Returns a new instance of DatabaseInstance
606 607 608 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 606 def initialize(**args) update!(**args) end |
Instance Attribute Details
#backend_type ⇒ String
FIRST_GEN: First Generation instance. MySQL only.
SECOND_GEN: Second Generation instance or PostgreSQL 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 and Second or First Generation.
Corresponds to the JSON property backendType
441 442 443 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 441 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
446 447 448 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 446 def connection_name @connection_name end |
#current_disk_size ⇒ Fixnum
The current disk usage of the instance in bytes. This property has been
deprecated. Users should 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
454 455 456 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 454 def current_disk_size @current_disk_size end |
#database_version ⇒ String
The database engine type and version. The databaseVersion field can not be
changed after instance creation. MySQL Second Generation instances: MYSQL_5_7 (
default) or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6 (default) or
POSTGRES_11 Beta. MySQL First Generation instances: MYSQL_5_6 (default) or
MYSQL_5_5
Corresponds to the JSON property databaseVersion
463 464 465 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 463 def database_version @database_version end |
#disk_encryption_configuration ⇒ Google::Apis::SqladminV1beta4::DiskEncryptionConfiguration
Disk encryption configuration.
Corresponds to the JSON property diskEncryptionConfiguration
468 469 470 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 468 def disk_encryption_configuration @disk_encryption_configuration end |
#disk_encryption_status ⇒ Google::Apis::SqladminV1beta4::DiskEncryptionStatus
Disk encryption status.
Corresponds to the JSON property diskEncryptionStatus
473 474 475 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 473 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
479 480 481 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 479 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
485 486 487 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 485 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
492 493 494 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 492 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 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
500 501 502 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 500 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
505 506 507 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 505 def ip_addresses @ip_addresses end |
#ipv6_address ⇒ String
The IPv6 address assigned to the instance. This property is applicable only to
First Generation instances.
Corresponds to the JSON property ipv6Address
511 512 513 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 511 def ipv6_address @ipv6_address end |
#kind ⇒ String
This is always sql#instance.
Corresponds to the JSON property kind
516 517 518 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 516 def kind @kind end |
#master_instance_name ⇒ String
The name of the instance which will act as master in the replication setup.
Corresponds to the JSON property masterInstanceName
521 522 523 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 521 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
526 527 528 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 526 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
531 532 533 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 531 def name @name end |
#on_premises_configuration ⇒ Google::Apis::SqladminV1beta4::OnPremisesConfiguration
On-premises instance configuration.
Corresponds to the JSON property onPremisesConfiguration
536 537 538 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 536 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
542 543 544 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 542 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 (First Generation or
Second Generation). The region can not be changed after instance creation.
Corresponds to the JSON property region
550 551 552 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 550 def region @region end |
#replica_configuration ⇒ Google::Apis::SqladminV1beta4::ReplicaConfiguration
Read-replica configuration for connecting to the master.
Corresponds to the JSON property replicaConfiguration
555 556 557 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 555 def replica_configuration @replica_configuration end |
#replica_names ⇒ Array<String>
The replicas of the instance.
Corresponds to the JSON property replicaNames
560 561 562 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 560 def replica_names @replica_names end |
#root_password ⇒ String
Initial root password. Use only on creation.
Corresponds to the JSON property rootPassword
565 566 567 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 565 def root_password @root_password end |
#self_link ⇒ String
The URI of this resource.
Corresponds to the JSON property selfLink
570 571 572 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 570 def self_link @self_link end |
#server_ca_cert ⇒ Google::Apis::SqladminV1beta4::SslCert
SslCerts Resource
Corresponds to the JSON property serverCaCert
575 576 577 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 575 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
581 582 583 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 581 def service_account_email_address @service_account_email_address end |
#settings ⇒ Google::Apis::SqladminV1beta4::Settings
Database instance settings.
Corresponds to the JSON property settings
586 587 588 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 586 def settings @settings end |
#state ⇒ String
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
599 600 601 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 599 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
604 605 606 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 604 def suspension_reason @suspension_reason end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 |
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 611 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) @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 |