Backup and DR Service V1 API - Class Google::Cloud::BackupDR::V1::BackupPlan (v0.4.0)

Reference documentation and code samples for the Backup and DR Service V1 API class Google::Cloud::BackupDR::V1::BackupPlan.

A BackupPlan specifies some common fields, such as description as well as one or more BackupRule messages. Each BackupRule has a retention policy and defines a schedule by which the system is to perform backup workloads.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#backup_rules

def backup_rules() -> ::Array<::Google::Cloud::BackupDR::V1::BackupRule>
Returns

#backup_rules=

def backup_rules=(value) -> ::Array<::Google::Cloud::BackupDR::V1::BackupRule>
Parameter
Returns

#backup_vault

def backup_vault() -> ::String
Returns
  • (::String) — Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}

#backup_vault=

def backup_vault=(value) -> ::String
Parameter
  • value (::String) — Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
Returns
  • (::String) — Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}

#backup_vault_service_account

def backup_vault_service_account() -> ::String
Returns
  • (::String) — Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. The description of the BackupPlan resource.

    The description allows for additional details about BackupPlan and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. The description of the BackupPlan resource.

    The description allows for additional details about BackupPlan and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.

Returns
  • (::String) — Optional. The description of the BackupPlan resource.

    The description allows for additional details about BackupPlan and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.

#etag

def etag() -> ::String
Returns
  • (::String) — Optional. etag is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — Optional. etag is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.
Returns
  • (::String) — Optional. etag is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.

#name

def name() -> ::String
Returns
  • (::String) — Output only. Identifier. The resource name of the BackupPlan.

    Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}

#resource_type

def resource_type() -> ::String
Returns
  • (::String) — Required. The resource type to which the BackupPlan will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".

#resource_type=

def resource_type=(value) -> ::String
Parameter
  • value (::String) — Required. The resource type to which the BackupPlan will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".
Returns
  • (::String) — Required. The resource type to which the BackupPlan will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".

#state

def state() -> ::Google::Cloud::BackupDR::V1::BackupPlan::State
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns