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

### Custom Resources

* [Dumpling](#dumpling)

### Sub Resources

* [DumplingList](#dumplinglist)
* [DumplingSpec](#dumplingspec)
* [DumplingStatus](#dumplingstatus)

#### Dumpling

Dumpling is the Schema for the dumplings API

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| metadata |  | metav1.ObjectMeta | false |
| spec |  | [DumplingSpec](#dumplingspec) | false |
| status |  | [DumplingStatus](#dumplingstatus) | false |

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

#### DumplingList

DumplingList contains a list of Dumpling

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

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

#### DumplingSpec

DumplingSpec defines the desired state of Dumpling

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| user | info of the tidb cluster | string | true |
| password |  | string | true |
| bucketPath | BucketPath is the target bucket address with path,  use s3 uri | string | true |
| s3Accesskey |  | string | true |
| s3Secretkey |  | string | true |
| options | Options is the parameters list of dumpling | []string | false |
| tableFilter | TableFilter means Table filter expression for 'db.table' matching. BR supports this from v4.0.3. | []string | false |
| clusterName | ClusterName is the target cluster name, target cluster must exist in the same namespace as dumpling | string | true |
| region | region for s3 bucket | string | false |

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

#### DumplingStatus

DumplingStatus defines the observed state of Dumpling

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| phase | Phase is lifecycle phase of the Dumpling | DumplingPhase | false |
| message | Message is the error message of the Dumpling. | string | false |
| backupPath | BackupPath is the location of the dumpling. | string | false |
| backupSizeReadable | BackupSizeReadable is the data size of the backup. the difference with BackupSize is that its format is human readable | string | false |
| backupSize | BackupSize is the data size of the backup. | int64 | false |

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