Class: Google::Cloud::AlloyDB::V1alpha::UpgradeClusterResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/alloydb/v1alpha/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::V1alpha::UpgradeClusterResponse::ClusterUpgradeDetails>

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

Returns:



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'proto_docs/google/cloud/alloydb/v1alpha/service.rb', line 238

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::V1alpha::UpgradeClusterResponse::Stage]
  #     The stage.
  # @!attribute [rw] status
  #   @return [::Google::Cloud::AlloyDB::V1alpha::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 instaces associated with a cluster.
  # @!attribute [rw] name
  #   @return [::String]
  #     Normalized name of the instance.
  # @!attribute [rw] upgrade_status
  #   @return [::Google::Cloud::AlloyDB::V1alpha::UpgradeClusterResponse::Status]
  #     Upgrade status of the instance.
  # @!attribute [rw] instance_type
  #   @return [::Google::Cloud::AlloyDB::V1alpha::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::V1alpha::UpgradeClusterResponse::Status]
  #     Upgrade status of the cluster.
  # @!attribute [rw] cluster_type
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Cluster::ClusterType]
  #     Cluster type which can either be primary or secondary.
  # @!attribute [rw] database_version
  #   @return [::Google::Cloud::AlloyDB::V1alpha::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::V1alpha::UpgradeClusterResponse::StageInfo>]
  #     Array containing stage info associated with this cluster.
  # @!attribute [rw] instance_upgrade_details
  #   @return [::Array<::Google::Cloud::AlloyDB::V1alpha::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.



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'proto_docs/google/cloud/alloydb/v1alpha/service.rb', line 238

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::V1alpha::UpgradeClusterResponse::Stage]
  #     The stage.
  # @!attribute [rw] status
  #   @return [::Google::Cloud::AlloyDB::V1alpha::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 instaces associated with a cluster.
  # @!attribute [rw] name
  #   @return [::String]
  #     Normalized name of the instance.
  # @!attribute [rw] upgrade_status
  #   @return [::Google::Cloud::AlloyDB::V1alpha::UpgradeClusterResponse::Status]
  #     Upgrade status of the instance.
  # @!attribute [rw] instance_type
  #   @return [::Google::Cloud::AlloyDB::V1alpha::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::V1alpha::UpgradeClusterResponse::Status]
  #     Upgrade status of the cluster.
  # @!attribute [rw] cluster_type
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Cluster::ClusterType]
  #     Cluster type which can either be primary or secondary.
  # @!attribute [rw] database_version
  #   @return [::Google::Cloud::AlloyDB::V1alpha::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::V1alpha::UpgradeClusterResponse::StageInfo>]
  #     Array containing stage info associated with this cluster.
  # @!attribute [rw] instance_upgrade_details
  #   @return [::Array<::Google::Cloud::AlloyDB::V1alpha::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::V1alpha::UpgradeClusterResponse::Status

Returns Status of upgrade operation.

Returns:



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'proto_docs/google/cloud/alloydb/v1alpha/service.rb', line 238

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::V1alpha::UpgradeClusterResponse::Stage]
  #     The stage.
  # @!attribute [rw] status
  #   @return [::Google::Cloud::AlloyDB::V1alpha::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 instaces associated with a cluster.
  # @!attribute [rw] name
  #   @return [::String]
  #     Normalized name of the instance.
  # @!attribute [rw] upgrade_status
  #   @return [::Google::Cloud::AlloyDB::V1alpha::UpgradeClusterResponse::Status]
  #     Upgrade status of the instance.
  # @!attribute [rw] instance_type
  #   @return [::Google::Cloud::AlloyDB::V1alpha::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::V1alpha::UpgradeClusterResponse::Status]
  #     Upgrade status of the cluster.
  # @!attribute [rw] cluster_type
  #   @return [::Google::Cloud::AlloyDB::V1alpha::Cluster::ClusterType]
  #     Cluster type which can either be primary or secondary.
  # @!attribute [rw] database_version
  #   @return [::Google::Cloud::AlloyDB::V1alpha::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::V1alpha::UpgradeClusterResponse::StageInfo>]
  #     Array containing stage info associated with this cluster.
  # @!attribute [rw] instance_upgrade_details
  #   @return [::Array<::Google::Cloud::AlloyDB::V1alpha::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