Class: Google::Cloud::BackupDR::V1::Backup

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

Overview

Message describing a Backup object.

Defined Under Namespace

Modules: BackupType, State Classes: GCPBackupPlanInfo, LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#backup_appliance_backup_properties ⇒ ::Google::Cloud::BackupDR::V1::BackupApplianceBackupProperties (readonly)

Returns Output only. Backup Appliance specific backup properties.

Note: The following fields are mutually exclusive: backup_appliance_backup_properties, compute_instance_backup_properties, cloud_sql_instance_backup_properties, disk_backup_properties. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::BackupDR::V1::BackupApplianceBackupProperties) —

    Output only. Backup Appliance specific backup properties.

    Note: The following fields are mutually exclusive: backup_appliance_backup_properties, compute_instance_backup_properties, cloud_sql_instance_backup_properties, disk_backup_properties. If a field in that set is populated, all other fields in the set will automatically be cleared.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#backup_appliance_locks ⇒ ::Array<::Google::Cloud::BackupDR::V1::BackupLock>

Returns Optional. The list of BackupLocks taken by the accessor Backup Appliance.

Returns:



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#backup_type ⇒ ::Google::Cloud::BackupDR::V1::Backup::BackupType (readonly)

Returns Output only. Type of the backup, unspecified, scheduled or ondemand.

Returns:



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#cloud_sql_instance_backup_properties ⇒ ::Google::Cloud::BackupDR::V1::CloudSqlInstanceBackupProperties (readonly)

Returns Output only. Cloud SQL specific backup properties.

Note: The following fields are mutually exclusive: cloud_sql_instance_backup_properties, compute_instance_backup_properties, backup_appliance_backup_properties, disk_backup_properties. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::BackupDR::V1::CloudSqlInstanceBackupProperties) —

    Output only. Cloud SQL specific backup properties.

    Note: The following fields are mutually exclusive: cloud_sql_instance_backup_properties, compute_instance_backup_properties, backup_appliance_backup_properties, disk_backup_properties. If a field in that set is populated, all other fields in the set will automatically be cleared.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#compute_instance_backup_properties ⇒ ::Google::Cloud::BackupDR::V1::ComputeInstanceBackupProperties (readonly)

Returns Output only. Compute Engine specific backup properties.

Note: The following fields are mutually exclusive: compute_instance_backup_properties, cloud_sql_instance_backup_properties, backup_appliance_backup_properties, disk_backup_properties. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::BackupDR::V1::ComputeInstanceBackupProperties) —

    Output only. Compute Engine specific backup properties.

    Note: The following fields are mutually exclusive: compute_instance_backup_properties, cloud_sql_instance_backup_properties, backup_appliance_backup_properties, disk_backup_properties. If a field in that set is populated, all other fields in the set will automatically be cleared.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

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

Returns Output only. The point in time when this backup was captured from the source.

Returns:



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

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

Returns Output only. The time when the instance was created.

Returns:



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#description ⇒ ::String (readonly)

Returns Output only. The description of the Backup instance (2048 characters or less).

Returns:

  • (::String) —

    Output only. The description of the Backup instance (2048 characters or less).



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#disk_backup_properties ⇒ ::Google::Cloud::BackupDR::V1::DiskBackupProperties (readonly)

Returns Output only. Disk specific backup properties.

Note: The following fields are mutually exclusive: disk_backup_properties, compute_instance_backup_properties, cloud_sql_instance_backup_properties, backup_appliance_backup_properties. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::BackupDR::V1::DiskBackupProperties) —

    Output only. Disk specific backup properties.

    Note: The following fields are mutually exclusive: disk_backup_properties, compute_instance_backup_properties, cloud_sql_instance_backup_properties, backup_appliance_backup_properties. If a field in that set is populated, all other fields in the set will automatically be cleared.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#enforced_retention_end_time ⇒ ::Google::Protobuf::Timestamp

Returns Optional. The backup can not be deleted before this time.

Returns:



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#etag ⇒ ::String

Returns Optional. Server specified ETag to prevent updates from overwriting each other.

Returns:

  • (::String) —

    Optional. Server specified ETag to prevent updates from overwriting each other.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#expire_time ⇒ ::Google::Protobuf::Timestamp

Returns Optional. When this backup is automatically expired.

Returns:



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#gcp_backup_plan_info ⇒ ::Google::Cloud::BackupDR::V1::Backup::GCPBackupPlanInfo (readonly)

Returns Output only. Configuration for a Google Cloud resource.

Returns:



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

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

Returns Optional. Resource labels to represent user provided metadata. No labels currently defined.

Returns:

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

    Optional. Resource labels to represent user provided metadata. No labels currently defined.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Identifier. Name of the backup to create. It must have the format"projects/<project>/locations/<location>/backupVaults/<backupvault>/dataSources/{datasource}/backups/{backup}". {backup} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.

Returns:

  • (::String) —

    Output only. Identifier. Name of the backup to create. It must have the format"projects/<project>/locations/<location>/backupVaults/<backupvault>/dataSources/{datasource}/backups/{backup}". {backup} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#resource_size_bytes ⇒ ::Integer (readonly)

Returns Output only. source resource size in bytes at the time of the backup.

Returns:

  • (::Integer) —

    Output only. source resource size in bytes at the time of the backup.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Optional. Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Optional. Output only. Reserved for future use.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Optional. Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Optional. Output only. Reserved for future use.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#service_locks ⇒ ::Array<::Google::Cloud::BackupDR::V1::BackupLock> (readonly)

Returns Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.

Returns:



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

#state ⇒ ::Google::Cloud::BackupDR::V1::Backup::State (readonly)

Returns Output only. The Backup resource instance state.

Returns:



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end

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

Returns Output only. The time when the instance was updated.

Returns:



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 556

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

  # GCPBackupPlanInfo captures the plan configuration details of Google Cloud
  # resources at the time of backup.
  # @!attribute [rw] backup_plan
  #   @return [::String]
  #     Resource name of backup plan by which workload is protected at the time
  #     of the backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
  # @!attribute [rw] backup_plan_rule_id
  #   @return [::String]
  #     The rule id of the backup plan which triggered this backup in case of
  #     scheduled backup or used for
  # @!attribute [rw] backup_plan_revision_name
  #   @return [::String]
  #     Resource name of the backup plan revision which triggered this backup in
  #     case of scheduled backup or used for on demand backup.
  #     Format:
  #     projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
  # @!attribute [rw] backup_plan_revision_id
  #   @return [::String]
  #     The user friendly id of the backup plan revision which triggered this
  #     backup in case of scheduled backup or used for on demand backup.
  class GCPBackupPlanInfo
    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

  # Holds the state of the backup resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup is being created.
    CREATING = 1

    # The backup has been created and is fully usable.
    ACTIVE = 2

    # The backup is being deleted.
    DELETING = 3

    # The backup is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup is being uploaded.
    UPLOADING = 5
  end

  # Type of the backup, scheduled or ondemand.
  module BackupType
    # Backup type is unspecified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # Scheduled backup.
    SCHEDULED = 1

    # On demand backup.
    ON_DEMAND = 2

    # Operational backup.
    ON_DEMAND_OPERATIONAL = 3
  end
end