Class: Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse

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

Overview

UpgradeClusterResponse contains the response for upgrade cluster operation.

Defined Under Namespace

Modules: Stage, Status Classes: ClusterUpgradeDetails, InstanceUpgradeDetails, StageInfo

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_upgrade_details ⇒ ::Array<::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::ClusterUpgradeDetails>

Returns Array of upgrade details for the current cluster and all the secondary clusters associated with this cluster.

Returns:



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
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
 
# File 'proto_docs/google/cloud/alloydb/v1beta/service.rb', line 411

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

  # Stage information for different stages in the upgrade process.
  # @!attribute [rw] stage
  #   @return [::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::Stage]
  #     The stage.
  # @!attribute [rw] status
  #   @return [::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::Status]
  #     Status of the stage.
  # @!attribute [rw] logs_url
  #   @return [::String]
  #     logs_url is the URL for the logs associated with a stage if that stage
  #     has logs. Right now, only three stages have logs: ALLOYDB_PRECHECK,
  #     PG_UPGRADE_CHECK, PRIMARY_INSTANCE_UPGRADE.
  class StageInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details regarding the upgrade of instances associated with a cluster.
  # @!attribute [rw] name
  #   @return [::String]
  #     Normalized name of the instance.
  # @!attribute [rw] upgrade_status
  #   @return [::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::Status]
  #     Upgrade status of the instance.
  # @!attribute [rw] instance_type
  #   @return [::Google::Cloud::AlloyDB::V1beta::Instance::InstanceType]
  #     Instance type.
  class InstanceUpgradeDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Upgrade details of a cluster. This cluster can be primary or secondary.
  # @!attribute [rw] name
  #   @return [::String]
  #     Normalized name of the cluster
  # @!attribute [rw] upgrade_status
  #   @return [::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::Status]
  #     Upgrade status of the cluster.
  # @!attribute [rw] cluster_type
  #   @return [::Google::Cloud::AlloyDB::V1beta::Cluster::ClusterType]
  #     Cluster type which can either be primary or secondary.
  # @!attribute [rw] database_version
  #   @return [::Google::Cloud::AlloyDB::V1beta::DatabaseVersion]
  #     Database version of the cluster after the upgrade operation. This will be
  #     the target version if the upgrade was successful otherwise it remains the
  #     same as that before the upgrade operation.
  # @!attribute [rw] stage_info
  #   @return [::Array<::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::StageInfo>]
  #     Array containing stage info associated with this cluster.
  # @!attribute [rw] instance_upgrade_details
  #   @return [::Array<::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::InstanceUpgradeDetails>]
  #     Upgrade details of the instances directly associated with this cluster.
  class ClusterUpgradeDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of upgrade operation.
  module Status
    # Unspecified status.
    STATUS_UNSPECIFIED = 0

    # Not started.
    NOT_STARTED = 4

    # In progress.
    IN_PROGRESS = 5

    # Operation succeeded.
    SUCCESS = 1

    # Operation failed.
    FAILED = 2

    # Operation partially succeeded.
    PARTIAL_SUCCESS = 3

    # Cancel is in progress.
    CANCEL_IN_PROGRESS = 6

    # Cancellation complete.
    CANCELLED = 7
  end

  # Stage in the upgrade.
  module Stage
    # Unspecified stage.
    STAGE_UNSPECIFIED = 0

    # Pre-upgrade custom checks, not covered by pg_upgrade.
    ALLOYDB_PRECHECK = 1

    # Pre-upgrade pg_upgrade checks.
    PG_UPGRADE_CHECK = 2

    # Clone the original cluster.
    PREPARE_FOR_UPGRADE = 5

    # Upgrade the primary instance(downtime).
    PRIMARY_INSTANCE_UPGRADE = 3

    # This stage is read pool upgrade.
    READ_POOL_INSTANCES_UPGRADE = 4

    # Rollback in case of critical failures.
    ROLLBACK = 6

    # Cleanup.
    CLEANUP = 7
  end
end

#message ⇒ ::String

Returns A user friendly message summarising the upgrade operation details and the next steps for the user if there is any.

Returns:

  • (::String) —

    A user friendly message summarising the upgrade operation details and the next steps for the user if there is any.



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
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
 
# File 'proto_docs/google/cloud/alloydb/v1beta/service.rb', line 411

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

  # Stage information for different stages in the upgrade process.
  # @!attribute [rw] stage
  #   @return [::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::Stage]
  #     The stage.
  # @!attribute [rw] status
  #   @return [::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::Status]
  #     Status of the stage.
  # @!attribute [rw] logs_url
  #   @return [::String]
  #     logs_url is the URL for the logs associated with a stage if that stage
  #     has logs. Right now, only three stages have logs: ALLOYDB_PRECHECK,
  #     PG_UPGRADE_CHECK, PRIMARY_INSTANCE_UPGRADE.
  class StageInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details regarding the upgrade of instances associated with a cluster.
  # @!attribute [rw] name
  #   @return [::String]
  #     Normalized name of the instance.
  # @!attribute [rw] upgrade_status
  #   @return [::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::Status]
  #     Upgrade status of the instance.
  # @!attribute [rw] instance_type
  #   @return [::Google::Cloud::AlloyDB::V1beta::Instance::InstanceType]
  #     Instance type.
  class InstanceUpgradeDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Upgrade details of a cluster. This cluster can be primary or secondary.
  # @!attribute [rw] name
  #   @return [::String]
  #     Normalized name of the cluster
  # @!attribute [rw] upgrade_status
  #   @return [::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::Status]
  #     Upgrade status of the cluster.
  # @!attribute [rw] cluster_type
  #   @return [::Google::Cloud::AlloyDB::V1beta::Cluster::ClusterType]
  #     Cluster type which can either be primary or secondary.
  # @!attribute [rw] database_version
  #   @return [::Google::Cloud::AlloyDB::V1beta::DatabaseVersion]
  #     Database version of the cluster after the upgrade operation. This will be
  #     the target version if the upgrade was successful otherwise it remains the
  #     same as that before the upgrade operation.
  # @!attribute [rw] stage_info
  #   @return [::Array<::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::StageInfo>]
  #     Array containing stage info associated with this cluster.
  # @!attribute [rw] instance_upgrade_details
  #   @return [::Array<::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::InstanceUpgradeDetails>]
  #     Upgrade details of the instances directly associated with this cluster.
  class ClusterUpgradeDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of upgrade operation.
  module Status
    # Unspecified status.
    STATUS_UNSPECIFIED = 0

    # Not started.
    NOT_STARTED = 4

    # In progress.
    IN_PROGRESS = 5

    # Operation succeeded.
    SUCCESS = 1

    # Operation failed.
    FAILED = 2

    # Operation partially succeeded.
    PARTIAL_SUCCESS = 3

    # Cancel is in progress.
    CANCEL_IN_PROGRESS = 6

    # Cancellation complete.
    CANCELLED = 7
  end

  # Stage in the upgrade.
  module Stage
    # Unspecified stage.
    STAGE_UNSPECIFIED = 0

    # Pre-upgrade custom checks, not covered by pg_upgrade.
    ALLOYDB_PRECHECK = 1

    # Pre-upgrade pg_upgrade checks.
    PG_UPGRADE_CHECK = 2

    # Clone the original cluster.
    PREPARE_FOR_UPGRADE = 5

    # Upgrade the primary instance(downtime).
    PRIMARY_INSTANCE_UPGRADE = 3

    # This stage is read pool upgrade.
    READ_POOL_INSTANCES_UPGRADE = 4

    # Rollback in case of critical failures.
    ROLLBACK = 6

    # Cleanup.
    CLEANUP = 7
  end
end

#status ⇒ ::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::Status

Returns Status of upgrade operation.

Returns:



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
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
 
# File 'proto_docs/google/cloud/alloydb/v1beta/service.rb', line 411

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

  # Stage information for different stages in the upgrade process.
  # @!attribute [rw] stage
  #   @return [::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::Stage]
  #     The stage.
  # @!attribute [rw] status
  #   @return [::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::Status]
  #     Status of the stage.
  # @!attribute [rw] logs_url
  #   @return [::String]
  #     logs_url is the URL for the logs associated with a stage if that stage
  #     has logs. Right now, only three stages have logs: ALLOYDB_PRECHECK,
  #     PG_UPGRADE_CHECK, PRIMARY_INSTANCE_UPGRADE.
  class StageInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Details regarding the upgrade of instances associated with a cluster.
  # @!attribute [rw] name
  #   @return [::String]
  #     Normalized name of the instance.
  # @!attribute [rw] upgrade_status
  #   @return [::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::Status]
  #     Upgrade status of the instance.
  # @!attribute [rw] instance_type
  #   @return [::Google::Cloud::AlloyDB::V1beta::Instance::InstanceType]
  #     Instance type.
  class InstanceUpgradeDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Upgrade details of a cluster. This cluster can be primary or secondary.
  # @!attribute [rw] name
  #   @return [::String]
  #     Normalized name of the cluster
  # @!attribute [rw] upgrade_status
  #   @return [::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::Status]
  #     Upgrade status of the cluster.
  # @!attribute [rw] cluster_type
  #   @return [::Google::Cloud::AlloyDB::V1beta::Cluster::ClusterType]
  #     Cluster type which can either be primary or secondary.
  # @!attribute [rw] database_version
  #   @return [::Google::Cloud::AlloyDB::V1beta::DatabaseVersion]
  #     Database version of the cluster after the upgrade operation. This will be
  #     the target version if the upgrade was successful otherwise it remains the
  #     same as that before the upgrade operation.
  # @!attribute [rw] stage_info
  #   @return [::Array<::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::StageInfo>]
  #     Array containing stage info associated with this cluster.
  # @!attribute [rw] instance_upgrade_details
  #   @return [::Array<::Google::Cloud::AlloyDB::V1beta::UpgradeClusterResponse::InstanceUpgradeDetails>]
  #     Upgrade details of the instances directly associated with this cluster.
  class ClusterUpgradeDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of upgrade operation.
  module Status
    # Unspecified status.
    STATUS_UNSPECIFIED = 0

    # Not started.
    NOT_STARTED = 4

    # In progress.
    IN_PROGRESS = 5

    # Operation succeeded.
    SUCCESS = 1

    # Operation failed.
    FAILED = 2

    # Operation partially succeeded.
    PARTIAL_SUCCESS = 3

    # Cancel is in progress.
    CANCEL_IN_PROGRESS = 6

    # Cancellation complete.
    CANCELLED = 7
  end

  # Stage in the upgrade.
  module Stage
    # Unspecified stage.
    STAGE_UNSPECIFIED = 0

    # Pre-upgrade custom checks, not covered by pg_upgrade.
    ALLOYDB_PRECHECK = 1

    # Pre-upgrade pg_upgrade checks.
    PG_UPGRADE_CHECK = 2

    # Clone the original cluster.
    PREPARE_FOR_UPGRADE = 5

    # Upgrade the primary instance(downtime).
    PRIMARY_INSTANCE_UPGRADE = 3

    # This stage is read pool upgrade.
    READ_POOL_INSTANCES_UPGRADE = 4

    # Rollback in case of critical failures.
    ROLLBACK = 6

    # Cleanup.
    CLEANUP = 7
  end
end