---
title: Backup for GKE Restore Plan
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > DDSQL Reference > Data Directory > Backup for GKE Restore Plan
---

# Backup for GKE Restore Plan

A Backup for GKE Restore Plan in Google Cloud defines how and where to restore a previously created GKE backup. It specifies the target cluster, restore configuration, and policies for handling existing resources and namespaces. This resource helps automate and manage the recovery of Kubernetes workloads, ensuring consistent and reliable restoration of applications and data.

```
gcp.gkebackup_restore
```

## Fields

| Title                                | ID   | Type          | Data Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Description |
| ------------------------------------ | ---- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| _key                                 | core | string        |
| ancestors                            | core | array<string> |
| backup                               | core | string        | Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: `projects/*/locations/*/backupPlans/*/backups/*`.                                                                                                                                                                                                                                                                                                        |
| cluster                              | core | string        | Output only. The target cluster into which this Restore will restore data. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` Inherited from parent RestorePlan's cluster value.                                                                                                                                                                                                                                                                                                                                    |
| complete_time                        | core | timestamp     | Output only. Timestamp of when the restore operation completed.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| create_time                          | core | timestamp     | Output only. The timestamp when this Restore resource was created.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| datadog_display_name                 | core | string        |
| description                          | core | string        | Optional. User specified descriptive string for this Restore.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| etag                                 | core | string        | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestore`, and systems are expected to put that etag in the request to `UpdateRestore` or `DeleteRestore` to ensure that their change will be applied to the same version of the resource. |
| filter                               | core | json          | Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everything is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`.                                           |
| labels                               | core | array<string> | A set of custom labels supplied by user.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| name                                 | core | string        | Output only. Identifier. The full name of the Restore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*`                                                                                                                                                                                                                                                                                                                                                                                                                              |
| organization_id                      | core | string        |
| parent                               | core | string        |
| project_id                           | core | string        |
| project_number                       | core | string        |
| region_id                            | core | string        |
| resource_name                        | core | string        |
| resources_excluded_count             | core | int64         | Output only. Number of resources excluded during the restore execution.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| resources_failed_count               | core | int64         | Output only. Number of resources that failed to be restored during the restore execution.                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| resources_restored_count             | core | int64         | Output only. Number of resources restored during the restore execution.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| restore_config                       | core | json          | Output only. Configuration of the Restore. Inherited from parent RestorePlan's restore_config.                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| state                                | core | string        | Output only. The current state of the Restore.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| state_reason                         | core | string        | Output only. Human-readable description of why the Restore is in its current state. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.                                                                                                                                                                                                                                                                                                                            |
| tags                                 | core | hstore_csv    |
| uid                                  | core | string        | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.                                                                                                                                                                                                                                                                                                                                                                                                                   |
| update_time                          | core | timestamp     | Output only. The timestamp when this Restore resource was last updated.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| volume_data_restore_policy_overrides | core | json          | Optional. Immutable. Overrides the volume data restore policies selected in the Restore Config for override-scoped resources.                                                                                                                                                                                                                                                                                                                                                                                                                           |
| volumes_restored_count               | core | int64         | Output only. Number of volumes restored during the restore execution.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| zone_id                              | core | string        |
