Class: Google::Cloud::CloudDMS::V1::CloudSqlSettings

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb

Overview

Settings for creating a Cloud SQL database instance.

Defined Under Namespace

Modules: Edition, SqlActivationPolicy, SqlAvailabilityType, SqlDataDiskType, SqlDatabaseVersion Classes: DatabaseFlagsEntry, UserLabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#activation_policy ⇒ ::Google::Cloud::CloudDMS::V1::CloudSqlSettings::SqlActivationPolicy

Returns The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values:

'ALWAYS': The instance is on, and remains so even in the absence of connection requests.

NEVER: The instance is off; it is not activated, even if a connection request arrives.

Returns:

  • (::Google::Cloud::CloudDMS::V1::CloudSqlSettings::SqlActivationPolicy) —

    The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values:

    'ALWAYS': The instance is on, and remains so even in the absence of connection requests.

    NEVER: The instance is off; it is not activated, even if a connection request arrives.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#auto_storage_increase ⇒ ::Google::Protobuf::BoolValue

Returns [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

Returns:

  • (::Google::Protobuf::BoolValue) —

    [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#availability_type ⇒ ::Google::Cloud::CloudDMS::V1::CloudSqlSettings::SqlAvailabilityType

Returns Optional. Availability type. Potential values:

  • ZONAL: The instance serves data from only one zone. Outages in that zone affect data availability.
  • REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

Returns:



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#cmek_key_name ⇒ ::String

Returns The KMS key name used for the csql instance.

Returns:

  • (::String) —

    The KMS key name used for the csql instance.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#collation ⇒ ::String

Returns The Cloud SQL default instance level collation.

Returns:

  • (::String) —

    The Cloud SQL default instance level collation.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#data_disk_size_gb ⇒ ::Google::Protobuf::Int64Value

Returns The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

Returns:



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#data_disk_type ⇒ ::Google::Cloud::CloudDMS::V1::CloudSqlSettings::SqlDataDiskType

Returns The type of storage: PD_SSD (default) or PD_HDD.

Returns:



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#database_flags ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#database_version ⇒ ::Google::Cloud::CloudDMS::V1::CloudSqlSettings::SqlDatabaseVersion

Returns The database engine type and version.

Returns:



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#edition ⇒ ::Google::Cloud::CloudDMS::V1::CloudSqlSettings::Edition

Returns Optional. The edition of the given Cloud SQL instance.

Returns:



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#ip_config ⇒ ::Google::Cloud::CloudDMS::V1::SqlIpConfig

Returns The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

Returns:

  • (::Google::Cloud::CloudDMS::V1::SqlIpConfig) —

    The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#root_password ⇒ ::String

Returns Input only. Initial root password.

Returns:

  • (::String) —

    Input only. Initial root password.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#root_password_set ⇒ ::Boolean (readonly)

Returns Output only. Indicates If this connection profile root password is stored.

Returns:

  • (::Boolean) —

    Output only. Indicates If this connection profile root password is stored.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#secondary_zone ⇒ ::String

Returns Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).

Returns:

  • (::String) —

    Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#source_id ⇒ ::String

Returns The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID.

Returns:

  • (::String) —

    The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#storage_auto_resize_limit ⇒ ::Google::Protobuf::Int64Value

Returns The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

Returns:

  • (::Google::Protobuf::Int64Value) —

    The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#tier ⇒ ::String

Returns The tier (or machine type) for this instance, for example: db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For more information, see Cloud SQL Instance Settings.

Returns:

  • (::String) —

    The tier (or machine type) for this instance, for example: db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For more information, see Cloud SQL Instance Settings.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "18kg", "count": "3" }.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

    Example: { "name": "wrench", "mass": "18kg", "count": "3" }.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end

#zone ⇒ ::String

Returns The Google Cloud Platform zone where your Cloud SQL database instance is located.

Returns:

  • (::String) —

    The Google Cloud Platform zone where your Cloud SQL database instance is located.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 368

class CloudSqlSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DatabaseFlagsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies when the instance should be activated.
  module SqlActivationPolicy
    # unspecified policy.
    SQL_ACTIVATION_POLICY_UNSPECIFIED = 0

    # The instance is always up and running.
    ALWAYS = 1

    # The instance should never spin up.
    NEVER = 2
  end

  # The storage options for Cloud SQL databases.
  module SqlDataDiskType
    # Unspecified.
    SQL_DATA_DISK_TYPE_UNSPECIFIED = 0

    # SSD disk.
    PD_SSD = 1

    # HDD disk.
    PD_HDD = 2
  end

  # The database engine type and version.
  module SqlDatabaseVersion
    # Unspecified version.
    SQL_DATABASE_VERSION_UNSPECIFIED = 0

    # MySQL 5.6.
    MYSQL_5_6 = 1

    # MySQL 5.7.
    MYSQL_5_7 = 2

    # PostgreSQL 9.6.
    POSTGRES_9_6 = 3

    # PostgreSQL 11.
    POSTGRES_11 = 4

    # PostgreSQL 10.
    POSTGRES_10 = 5

    # MySQL 8.0.
    MYSQL_8_0 = 6

    # PostgreSQL 12.
    POSTGRES_12 = 7

    # PostgreSQL 13.
    POSTGRES_13 = 8

    # PostgreSQL 14.
    POSTGRES_14 = 17

    # PostgreSQL 15.
    POSTGRES_15 = 18
  end

  # The availability type of the given Cloud SQL instance.
  module SqlAvailabilityType
    # This is an unknown Availability type.
    SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0

    # Zonal availablility instance.
    ZONAL = 1

    # Regional availability instance.
    REGIONAL = 2
  end

  # The edition of the given Cloud SQL instance.
  # Can be ENTERPRISE or ENTERPRISE_PLUS.
  module Edition
    # The instance did not specify the edition.
    EDITION_UNSPECIFIED = 0

    # The instance is an enterprise edition.
    ENTERPRISE = 2

    # The instance is an enterprise plus edition.
    ENTERPRISE_PLUS = 3
  end
end