This resource is namespace scoped, refer to [Namespace](./namespace.md) for details.

### Custom Resources

* [Restore](#restore)

### Sub Resources

* [From](#from)
* [RestoreList](#restorelist)
* [RestoreProgress](#restoreprogress)
* [RestoreSpec](#restorespec)
* [RestoreStatus](#restorestatus)

#### From



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| backup | Backup is the name of the target Backup object, if this field is specified, the backup data will be retrieved from the Backup job. The Backup must exist in the same namespace if specified. | string | true |
| logBackup | LogBackup represents to execute PiTR it is the name of Backup object with Log mode its usage is same as Backup field | *string | false |
| PiTRRestoredTS | PiTRRestoredTS is the PiTR restored ts. it is used when LogBackup is specified | *string | false |

[Back to Custom Resources](#custom-resources)

#### Restore

Restore is the Schema for the restores API

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| metadata |  | metav1.ObjectMeta | false |
| spec |  | [RestoreSpec](#restorespec) | false |
| status |  | [RestoreStatus](#restorestatus) | false |

[Back to Custom Resources](#custom-resources)

#### RestoreList

RestoreList contains a list of Restore

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| metadata |  | metav1.ListMeta | false |
| items |  | [][Restore](#restore) | true |

[Back to Custom Resources](#custom-resources)

#### RestoreProgress



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| step | Step is the step name of progress | string | false |
| progress | Progress is the restore progress percentage value | int32 | false |
| lastTransitionTime | LastTransitionTime is the update time | metav1.Time | false |

[Back to Custom Resources](#custom-resources)

#### RestoreSpec

RestoreSpec defines the desired state of Restore

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| clusterName | ClusterName specifies the name of the target cluster where data is restored to, the cluster must exist in the same namespace with Restore | string | true |
| from | From specified where the backup data locates | [From](#from) | true |

[Back to Custom Resources](#custom-resources)

#### RestoreStatus

RestoreStatus defines the observed state of Restore

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| phase | Phase denotes the current restore progress | RestoreConditionType | true |
| progresses |  | [][RestoreProgress](#restoreprogress) | false |

[Back to Custom Resources](#custom-resources)