REST Resource: projects.locations.resourceBackupConfigs

Resource: ResourceBackupConfig

ResourceBackupConfig represents a resource along with its backup configurations.

JSON representation 
{
  "name": string,
  "uid": string,
  "targetResource": string,
  "targetResourceDisplayName": string,
  "targetResourceType": enum (ResourceType),
  "targetResourceLabels": {
    string: string,
    ...
  },
  "backupConfigsDetails": [
    {
      object (BackupConfigDetails)
    }
  ],
  "backupConfigured": boolean,
  "vaulted": boolean
}
Fields
name

string

Identifier. The resource name of the ResourceBackupConfig. Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}
uid

string

Output only. The unique identifier of the resource backup config.
targetResource

string

Output only. The full resource name of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType.
targetResourceDisplayName

string

Output only. The human friendly name of the target resource.
targetResourceType

enum (ResourceType)

Output only. The type of the target resource.
targetResourceLabels

map (key: string, value: string)

Labels associated with the target resource.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
backupConfigsDetails[]

object (BackupConfigDetails)

Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.
backupConfigured

boolean

Output only. Whether the target resource is configured for backup. This is true if the backupConfigsDetails is not empty.
vaulted

boolean

Output only. Whether the target resource is protected by a backup vault. This is true if the backupConfigsDetails is not empty and any of the ResourceBackupConfig.backup_configs_details has a backup configuration with BackupConfigDetails.backup_vault set. set.

ResourceType

The type of the cloud resource.

Enums
RESOURCE_TYPE_UNSPECIFIED Resource type not set.
CLOUD_SQL_INSTANCE Cloud SQL instance.
COMPUTE_ENGINE_VM Compute Engine VM.

BackupConfigDetails

BackupConfigDetails has information about how the resource is configured for backups and about the most recent backup taken for this configuration.

JSON representation 
{
  "backupConfigSource": string,
  "backupConfigSourceDisplayName": string,
  "type": enum (Type),
  "state": enum (State),
  "pitrSettings": {
    object (PitrSettings)
  },
  "latestSuccessfulBackupTime": string,
  "applicableResource": string,
  "backupVault": string,
  "backupLocations": [
    {
      object (BackupLocation)
    }
  ],

  // Union field plan_specific_config can be only one of the following:
  "backupDrPlanConfig": {
    object (BackupDrPlanConfig)
  },
  "backupDrTemplateConfig": {
    object (BackupDrTemplateConfig)
  }
  // End of list of possible types for union field plan_specific_config.
}
Fields
backupConfigSource

string

Output only. The full resource name of the backup config source resource. For example, "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupPlans/{backupplanId}" or "//compute.googleapis.com/projects/{project}/locations/{region}/resourcePolicies/{resourcePolicyId}".
backupConfigSourceDisplayName

string

Output only. The display name of the backup config source resource.
type

enum (Type)

Output only. The type of the backup config resource.
state

enum (State)

Output only. The state of the backup config resource.
pitrSettings

object (PitrSettings)

Output only. Point in time recovery settings of the backup configuration resource.
latestSuccessfulBackupTime

string (Timestamp format)

Output only. Timestamp of the latest successful backup created via this backup configuration.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
applicableResource

string

Output only. The full resource name of the resource that is applicable for the backup configuration. Example: "//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}"
backupVault

string

Output only. The full resource name of the backup vault that will store the backups generated through this backup configuration. Example: "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupVaults/{backupvaultId}"
backupLocations[]

object (BackupLocation)

The locations where the backups are to be stored.
Union field plan_specific_config. The plan specific config. This depends on the value of BackupConfigDetails.type. For type=BACKUPDR_BACKUP_PLAN, backup_dr_plan_config would be populated to capture information related to Backup and DR's Backup Plans. For type=BACKUPDR_TEMPLATE, backup_dr_template_config would be populated to capture information related to Backup and DR's Template details. plan_specific_config can be only one of the following:
backupDrPlanConfig

object (BackupDrPlanConfig)

Backup and DR's Backup Plan specific data.
backupDrTemplateConfig

object (BackupDrTemplateConfig)

Backup and DR's Template specific data.

Type

Type of the backup configuration.

Enums
TYPE_UNSPECIFIED Backup config type is unspecified.
CLOUD_SQL_INSTANCE_BACKUP_CONFIG Backup config is Cloud SQL instance's automated backup config.
COMPUTE_ENGINE_RESOURCE_POLICY Backup config is Compute Engine Resource Policy.
BACKUPDR_BACKUP_PLAN Backup config is Backup and DR's Backup Plan.
BACKUPDR_TEMPLATE Backup config is Backup and DR's Template.

State

The state tells whether the backup config is active or not.

Enums
STATE_UNSPECIFIED Backup config state not set.
ACTIVE The config is in an active state protecting the resource
INACTIVE The config is currently not protecting the resource. Either because it is disabled or the owning project has been deleted without cleanup of the actual resource.
ERROR The config still exists but because of some error state it is not protecting the resource. Like the source project is deleted. For eg. PlanAssociation, BackupPlan is deleted.

PitrSettings

Point in time recovery settings of the backup configuration resource.

JSON representation 
{
  "retentionDays": integer
}
Fields
retentionDays

integer

Output only. Number of days to retain the backup.

BackupLocation

BackupLocation represents a cloud location where a backup can be stored.

JSON representation 
{
  "type": enum (Type),
  "locationId": string
}
Fields
type

enum (Type)

Output only. The type of the location.
locationId

string

Output only. The id of the cloud location. Example: "us-central1"

Type

The type of the location.

Enums
TYPE_UNSPECIFIED Location type is unspecified.
ZONAL Location type is zonal.
REGIONAL Location type is regional.
MULTI_REGIONAL Location type is multi regional.

BackupDrPlanConfig

BackupDrPlanConfig has additional information about Backup and DR's Plan backup configuration.

JSON representation 
{
  "backupDrPlanRules": [
    {
      object (BackupDrPlanRule)
    }
  ]
}
Fields
backupDrPlanRules[]

object (BackupDrPlanRule)

Backup rules of the backup plan resource.

BackupDrPlanRule

BackupDrPlanRule has rule specific information of the backup plan resource.

JSON representation 
{
  "ruleId": string,
  "lastSuccessfulBackupTime": string
}
Fields
ruleId

string

Output only. Unique Id of the backup rule.
lastSuccessfulBackupTime

string (Timestamp format)

Output only. Timestamp of the latest successful backup created via this backup rule.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

BackupDrTemplateConfig

BackupDrTemplateConfig has additional information about Backup and DR's Template backup configuration.

JSON representation 
{
  "firstPartyManagementUri": string,
  "thirdPartyManagementUri": string
}
Fields
firstPartyManagementUri

string

Output only. The URI of the BackupDr template resource for the first party identity users.
thirdPartyManagementUri

string

Output only. The URI of the BackupDr template resource for the third party identity users.

Methods

list

 Lists ResourceBackupConfigs.