Backup and DR Service V1BETA API - Class Google::Cloud::BackupDR::V1beta::BackupPlan (v0.1.0)

Reference documentation and code samples for the Backup and DR Service V1BETA API class Google::Cloud::BackupDR::V1beta::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::V1beta::BackupRule>
Returns

#backup_rules=

def backup_rules=(value) -> ::Array<::Google::Cloud::BackupDR::V1beta::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 service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.

#compute_instance_backup_plan_properties

def compute_instance_backup_plan_properties() -> ::Google::Cloud::BackupDR::V1beta::ComputeInstanceBackupPlanProperties
Returns
  • (::Google::Cloud::BackupDR::V1beta::ComputeInstanceBackupPlanProperties) — Optional. Defines optional properties specific to backups of compute instance based resources, such as Compute Engine Instances. This includes settings like whether to perform a guest flush.

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

#compute_instance_backup_plan_properties=

def compute_instance_backup_plan_properties=(value) -> ::Google::Cloud::BackupDR::V1beta::ComputeInstanceBackupPlanProperties
Parameter
  • value (::Google::Cloud::BackupDR::V1beta::ComputeInstanceBackupPlanProperties) — Optional. Defines optional properties specific to backups of compute instance based resources, such as Compute Engine Instances. This includes settings like whether to perform a guest flush.

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

Returns
  • (::Google::Cloud::BackupDR::V1beta::ComputeInstanceBackupPlanProperties) — Optional. Defines optional properties specific to backups of compute instance based resources, such as Compute Engine Instances. This includes settings like whether to perform a guest flush.

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

#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.

#disk_backup_plan_properties

def disk_backup_plan_properties() -> ::Google::Cloud::BackupDR::V1beta::DiskBackupPlanProperties
Returns
  • (::Google::Cloud::BackupDR::V1beta::DiskBackupPlanProperties) — Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush.

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

#disk_backup_plan_properties=

def disk_backup_plan_properties=(value) -> ::Google::Cloud::BackupDR::V1beta::DiskBackupPlanProperties
Parameter
  • value (::Google::Cloud::BackupDR::V1beta::DiskBackupPlanProperties) — Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush.

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

Returns
  • (::Google::Cloud::BackupDR::V1beta::DiskBackupPlanProperties) — Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush.

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

#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"}.

#log_retention_days

def log_retention_days() -> ::Integer
Returns
  • (::Integer) — Optional. Applicable only for Cloud SQL resource_type.

    Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.

#log_retention_days=

def log_retention_days=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Applicable only for Cloud SQL resource_type.

    Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.

Returns
  • (::Integer) — Optional. Applicable only for Cloud SQL resource_type.

    Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.

#max_custom_on_demand_retention_days

def max_custom_on_demand_retention_days() -> ::Integer
Returns
  • (::Integer) — Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.

#max_custom_on_demand_retention_days=

def max_custom_on_demand_retention_days=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.
Returns
  • (::Integer) — Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.

#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", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".

#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", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
Returns
  • (::String) — Required. The resource type to which the BackupPlan will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".

#revision_id

def revision_id() -> ::String
Returns
  • (::String) — Output only. The user friendly revision ID of the BackupPlanRevision.

    Example: v0, v1, v2, etc.

#revision_name

def revision_name() -> ::String
Returns
  • (::String) — Output only. The resource id of the BackupPlanRevision.

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

#state

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

#supported_resource_types

def supported_resource_types() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. All resource types to which backupPlan can be applied.

#update_time

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