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.

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.


531
532
533
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 531

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

Instance Attribute Details

#backend_typeString

FIRST_GEN: Basic Cloud SQL instance that runs in a Google-managed container. SECOND_GEN: A newer Cloud SQL backend that runs in a Compute Engine VM. EXTERNAL: A MySQL server that is not managed by Google. Corresponds to the JSON property backendType

Returns:

  • (String)

390
391
392
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 390

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)

395
396
397
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 395

def connection_name
  @connection_name
end

#current_disk_sizeString

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 https://groups. google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ for details. Corresponds to the JSON property currentDiskSize

Returns:

  • (String)

404
405
406
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 404

def current_disk_size
  @current_disk_size
end

#database_versionString

The database engine type and version. The databaseVersion can not be changed after instance creation. Can be MYSQL_5_5, MYSQL_5_6 or MYSQL_5_7. Defaults to MYSQL_5_6. MYSQL_5_7 is applicable only to Second Generation instances. Corresponds to the JSON property databaseVersion

Returns:

  • (String)

411
412
413
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 411

def database_version
  @database_version
end

#etagString

HTTP 1.1 Entity tag for the resource. Corresponds to the JSON property etag

Returns:

  • (String)

416
417
418
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 416

def etag
  @etag
end

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


422
423
424
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 422

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

430
431
432
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 430

def instance_type
  @instance_type
end

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

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


435
436
437
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 435

def ip_addresses
  @ip_addresses
end

#ipv6_addressString

The IPv6 address assigned to the instance. This property is applicable only to First Generation instances. Corresponds to the JSON property ipv6Address

Returns:

  • (String)

441
442
443
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 441

def ipv6_address
  @ipv6_address
end

#kindString

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

Returns:

  • (String)

446
447
448
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 446

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)

451
452
453
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 451

def master_instance_name
  @master_instance_name
end

#max_disk_sizeString

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

Returns:

  • (String)

456
457
458
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 456

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)

461
462
463
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 461

def name
  @name
end

#on_premises_configurationGoogle::Apis::SqladminV1beta4::OnPremisesConfiguration

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


466
467
468
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 466

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)

472
473
474
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 472

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 (First Generation or Second Generation). The region can not be changed after instance creation. Corresponds to the JSON property region

Returns:

  • (String)

480
481
482
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 480

def region
  @region
end

#replica_configurationGoogle::Apis::SqladminV1beta4::ReplicaConfiguration

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


485
486
487
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 485

def replica_configuration
  @replica_configuration
end

#replica_namesArray<String>

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

Returns:

  • (Array<String>)

490
491
492
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 490

def replica_names
  @replica_names
end

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

Returns:

  • (String)

495
496
497
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 495

def self_link
  @self_link
end

#server_ca_certGoogle::Apis::SqladminV1beta4::SslCert

SslCerts Resource Corresponds to the JSON property serverCaCert


500
501
502
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 500

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)

506
507
508
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 506

def 
  @service_account_email_address
end

#settingsGoogle::Apis::SqladminV1beta4::Settings

Database instance settings. Corresponds to the JSON property settings


511
512
513
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 511

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)

524
525
526
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 524

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

529
530
531
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 529

def suspension_reason
  @suspension_reason
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
# File 'generated/google/apis/sqladmin_v1beta4/classes.rb', line 536

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