Class: Google::Cloud::AlloyDB::V1::Cluster

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

Overview

A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.

Defined Under Namespace

Modules: ClusterType, State Classes: AnnotationsEntry, LabelsEntry, PrimaryConfig, SecondaryConfig

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128.

Returns:

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

    Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#automated_backup_policy ⇒ ::Google::Cloud::AlloyDB::V1::AutomatedBackupPolicy

Returns The automated backup policy for this cluster.

If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.

Returns:

  • (::Google::Cloud::AlloyDB::V1::AutomatedBackupPolicy) —

    The automated backup policy for this cluster.

    If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#backup_source ⇒ ::Google::Cloud::AlloyDB::V1::BackupSource (readonly)

Returns Output only. Cluster created from backup.

Returns:



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#cluster_type ⇒ ::Google::Cloud::AlloyDB::V1::Cluster::ClusterType (readonly)

Returns Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. CreateCluster vs. CreateSecondaryCluster.

Returns:

  • (::Google::Cloud::AlloyDB::V1::Cluster::ClusterType) —

    Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. CreateCluster vs. CreateSecondaryCluster



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#continuous_backup_config ⇒ ::Google::Cloud::AlloyDB::V1::ContinuousBackupConfig

Returns Optional. Continuous backup configuration for this cluster.

Returns:



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#continuous_backup_info ⇒ ::Google::Cloud::AlloyDB::V1::ContinuousBackupInfo (readonly)

Returns Output only. Continuous backup properties for this cluster.

Returns:



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Create time stamp.

Returns:



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#database_version ⇒ ::Google::Cloud::AlloyDB::V1::DatabaseVersion (readonly)

Returns Output only. The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

Returns:

  • (::Google::Cloud::AlloyDB::V1::DatabaseVersion) —

    Output only. The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#delete_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Delete time stamp.

Returns:



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#display_name ⇒ ::String

Returns User-settable and human-readable display name for the Cluster.

Returns:

  • (::String) —

    User-settable and human-readable display name for the Cluster.



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#encryption_config ⇒ ::Google::Cloud::AlloyDB::V1::EncryptionConfig

Returns Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.

Returns:

  • (::Google::Cloud::AlloyDB::V1::EncryptionConfig) —

    Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#encryption_info ⇒ ::Google::Cloud::AlloyDB::V1::EncryptionInfo (readonly)

Returns Output only. The encryption information for the cluster.

Returns:



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#etag ⇒ ::String

Returns For Resource freshness validation (https://google.aip.dev/154).

Returns:



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#initial_user ⇒ ::Google::Cloud::AlloyDB::V1::UserPassword

Returns Input only. Initial user to setup during cluster creation. Required. If used in RestoreCluster this is ignored.

Returns:



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

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

Returns Labels as key value pairs.

Returns:

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

    Labels as key value pairs



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#migration_source ⇒ ::Google::Cloud::AlloyDB::V1::MigrationSource (readonly)

Returns Output only. Cluster created via DMS migration.

Returns:



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The name of the cluster resource with the format:

  • projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression [a-z0-9-]+. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource:
  • projects/{project}/locations/{region}.

Returns:

  • (::String) —

    Output only. The name of the cluster resource with the format:

    • projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression [a-z0-9-]+. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource:
    • projects/{project}/locations/{region}


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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#network ⇒ ::String

Returns Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster. It can be updated, but it cannot be removed.

Returns:

  • (::String) —

    Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number}/global/networks/{network_id}". This is required to create a cluster. It can be updated, but it cannot be removed.



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#primary_config ⇒ ::Google::Cloud::AlloyDB::V1::Cluster::PrimaryConfig (readonly)

Returns Output only. Cross Region replication config specific to PRIMARY cluster.

Returns:



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#reconciling ⇒ ::Boolean (readonly)

Returns Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.

Returns:

  • (::Boolean) —

    Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#secondary_config ⇒ ::Google::Cloud::AlloyDB::V1::Cluster::SecondaryConfig

Returns Cross Region replication config specific to SECONDARY cluster.

Returns:



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#ssl_config ⇒ ::Google::Cloud::AlloyDB::V1::SslConfig

Returns SSL configuration for this AlloyDB cluster.

Returns:



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#state ⇒ ::Google::Cloud::AlloyDB::V1::Cluster::State (readonly)

Returns Output only. The current serving state of the cluster.

Returns:



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

Returns:

  • (::String) —

    Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Update time stamp.

Returns:



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'proto_docs/google/cloud/alloydb/v1/resources.rb', line 433

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

  # Configuration information for the secondary cluster. This should be set
  # if and only if the cluster is of type SECONDARY.
  # @!attribute [rw] primary_cluster_name
  #   @return [::String]
  #     The name of the primary cluster name with the format:
  #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
  class SecondaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration for the primary cluster. It has the list of clusters that are
  # replicating from this cluster. This should be set if and only if the
  # cluster is of type PRIMARY.
  # @!attribute [r] secondary_cluster_names
  #   @return [::Array<::String>]
  #     Output only. Names of the clusters that are replicating from this
  #     cluster.
  class PrimaryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

  # Cluster State
  module State
    # The state of the cluster is unknown.
    STATE_UNSPECIFIED = 0

    # The cluster is active and running.
    READY = 1

    # The cluster is stopped. All instances in the cluster are stopped.
    # Customers can start a stopped cluster at any point and all their
    # instances will come back to life with same names and IP resources. In
    # this state, customer pays for storage.
    # Associated backups could also be present in a stopped cluster.
    STOPPED = 2

    # The cluster is empty and has no associated resources.
    # All instances, associated storage and backups have been deleted.
    EMPTY = 3

    # The cluster is being created.
    CREATING = 4

    # The cluster is being deleted.
    DELETING = 5

    # The creation of the cluster failed.
    FAILED = 6

    # The cluster is bootstrapping with data from some other source.
    # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
    BOOTSTRAPPING = 7

    # The cluster is under maintenance. AlloyDB regularly performs maintenance
    # and upgrades on customer clusters. Updates on the cluster are
    # not allowed while the cluster is in this state.
    MAINTENANCE = 8

    # The cluster is being promoted.
    PROMOTING = 9
  end

  # Type of Cluster
  module ClusterType
    # The type of the cluster is unknown.
    CLUSTER_TYPE_UNSPECIFIED = 0

    # Primary cluster that support read and write operations.
    PRIMARY = 1

    # Secondary cluster that is replicating from another region.
    # This only supports read.
    SECONDARY = 2
  end
end