## postgresql.dbadmin.gdc.goog/v1

### Backup

Backup is the Schema for the backups API

*Appears in:*
- [BackupList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#backuplist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `Backup` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[BackupSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#backupspec)* |   |
| `status` *[BackupStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#backupstatus)* |   |

### BackupList

BackupList contains a list of Backup

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `BackupList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[Backup](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#backup) array* |   |

### BackupPlan

BackupPlan is the Schema for the backupplans API

*Appears in:*
- [BackupPlanList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#backupplanlist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `BackupPlan` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[BackupPlanSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#backupplanspec)* |   |
| `status` *[BackupPlanStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#backupplanstatus)* |   |

### BackupPlanList

BackupPlanList contains a list of BackupPlan

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `BackupPlanList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[BackupPlan](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#backupplan) array* |   |

### BackupPlanSpec

BackupPlanSpec defines the desired state of BackupPlan.

*Appears in:*
- [BackupPlan](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#backupplan)

| Field | Description |
|---|---|
| `dbclusterRef` *DBClusterRef* | The DBCluster name this backupplan configures. This field is required and immutable. |
| `backupRetainDays` *integer* | Number of days after which the service will delete a Backup. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches create_time + backup_retain_days. The valid values are from 1 to 90 days. Default to 14 retain days if not specified. |
| `paused` *boolean* | A flag to indicate if the backup creation under this BackupPlan is paused. If set to true, the service will pause the scheduling of new Backups under this BackupPlan. Default to False. |
| `PITREnabled` *boolean* | A flag to indicate whether logs replication is enabled to support point-in-time recovery. Default to False. nullon(samwise-fleet) |

### BackupPlanStatus

BackupPlanStatus defines the observed state of BackupPlan.

*Appears in:*
- [BackupPlan](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#backupplan)

| Field | Description |
|---|---|
| `observedGeneration` *integer* | Internal: The generation observed by the controller. |
| `reconciled` *boolean* | Internal: Whether the resource was reconciled by the controller. |
| `criticalIncidents` *[CriticalIncident](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#criticalincident) array* | CriticalIncidents is a flat list of all active Critical Incidents. |
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array* | Conditions represents the latest available observations of the Entity's current state. |
| `phase` *[BackupPlanPhase](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#backupplanphase)* |   |
| `lastBackupTime` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | LastBackupTime is the timestamp for the most recently executed backup. |
| `nextBackupTime` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | NextBackupTime is the timestamp for the next scheduled backup. |
| `recoveryWindow` *TimeWindow* | RecoveryWindow is the currently available recovery window. |
| `readWriteBackupRepositoryZone` *string* | ReadWriteBackupRepositoryZone is the current availability zone of the backup repository with ReadWrite import policy. |

### BackupSpec

BackupSpec defines the desired state of Backup.

*Appears in:*
- [Backup](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#backup)

| Field | Description |
|---|---|
| `dbclusterRef` *DBClusterRef* | The DBCluster name this backup belongs to. This field is required. |
| `backupPlanRef` *BackupPlanRef* | Name of the BackupPlan from which this backup was created. This field is required. |
| `manual` *boolean* | Indicate whether this backup is a scheduled or manual backup. This field is optional. Default to false (scheduled backup) if not specified. |

### BackupStatus

BackupStatus defines the observed state of Backup.

*Appears in:*
- [Backup](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#backup)

| Field | Description |
|---|---|
| `observedGeneration` *integer* | Internal: The generation observed by the controller. |
| `reconciled` *boolean* | Internal: Whether the resource was reconciled by the controller. |
| `criticalIncidents` *[CriticalIncident](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#criticalincident) array* | CriticalIncidents is a flat list of all active Critical Incidents. |
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array* | Conditions represents the latest available observations of the Entity's current state. |
| `phase` *[BackupPhase](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#backupphase)* |   |
| `createTime` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | Creation time of the Backup |
| `completeTime` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | Completion time of the Backup |

### CreateStandbyJob

CreateStandbyJob is an internal workflow tracking object. Users should not directly interact with this.

*Appears in:*
- [CreateStandbyJobList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#createstandbyjoblist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `CreateStandbyJob` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[WorkflowSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#workflowspec)* |   |
| `status` *[EntityStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#entitystatus)* |   |

### CreateStandbyJobList

CreateStandbyJobList contains a list of CreateStandbyJobs

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `CreateStandbyJobList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[CreateStandbyJob](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#createstandbyjob) array* |   |

### DBCluster

DBCluster is the Schema for the dbclusters API

*Appears in:*
- [DBClusterList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#dbclusterlist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `DBCluster` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[DBClusterSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#dbclusterspec)* |   |
| `status` *[DBClusterStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#dbclusterstatus)* |   |

### DBClusterHealth

*Appears in:*
- [DBClusterHealthList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#dbclusterhealthlist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `DBClusterHealth` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `status` *[DBClusterHealthStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#dbclusterhealthstatus)* |   |

### DBClusterHealthList

DBClusterHealthList contains a list of DBClusterHealth

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `DBClusterHealthList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[DBClusterHealth](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#dbclusterhealth) array* |   |

### DBClusterHealthStatus

DBClusterHealthStatus represents the current health state of a DBCluster's instances.

*Appears in:*
- [DBClusterHealth](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#dbclusterhealth)

| Field | Description |
|---|---|
| `observedGeneration` *integer* | Internal: The generation observed by the controller. |
| `reconciled` *boolean* | Internal: Whether the resource was reconciled by the controller. |
| `criticalIncidents` *[CriticalIncident](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#criticalincident) array* | CriticalIncidents is a flat list of all active Critical Incidents. |
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array* | Conditions represents the latest available observations of the Entity's current state. |
| `instances` *object (keys:string, values:[InstanceHealthStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#instancehealthstatus))* | Instances is a map keeping track of each of the health statuses of each instance. |

### DBClusterList

DBClusterList contains a list of DBCluster

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `DBClusterList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[DBCluster](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#dbcluster) array* |   |

### DBClusterSpec

DBClusterSpec defines the desired state of DBCluster

*Appears in:*
- [DBCluster](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#dbcluster)

| Field | Description |
|---|---|
| `primaryCluster` *string* | nullon(samwise-fleet) |
| `isDeleted` *boolean* | IsDeleted indicates a request to delete the DBCluster. This field is optional, and by default it is false. This fields applies to all instances of the database cluster. When set this to true, the control plane will attempt to release the related resources, including network endpoints. See the status fields for indication of success or failures, if any. |
| `mode` *string* | Indicate the mode of this DBCluster. |
| `availability` *[Availability](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#availability)* | Availability contains adjustable settings for DBCluster HA features |
| `allowExternalIncomingTraffic` *boolean* | AllowExternalIncomingTraffic is used to toggle external load balancer creation. |
| `tls` *[TLSSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#tlsspec)* | TLS is the desired server certificate configuration for the cluster. This field is optional. By default, this field is empty and a new self-signed CA and leaf certificate are generated for the cluster. When this field is changed, the database cluster pods will restart to load the specified certificate. The field `status.certificateReference` indicates the current CA certificate secret and key. |
| `databaseVersion` *string* | DatabaseVersion is the desired database version for the cluster for example, "15.4.5". This field is required. This version is applied to all instances of the database cluster. In the case of a new database cluster, the instance is created using the specified version. In the case of an existing database cluster, the operator aptempts to upgrade or downgrade to the specified `databaseVersion`. The field `status.currentDatabaseVersion` indicates the current database version. See the list of available versions in {link}. |
| `controlPlaneAgentsVersion` *string* | ControlPlaneAgentsVersion is the desired control plane agents version for the cluster for example, "0.5.2". This field is required. The `controlPlaneAgentsVersion` must be compatible with the chosen `databaseVersion`. To know what versions are compatible, check the list of available versions in {link}. This version is applied to all instances of the database cluster. In the case of a new database cluster, the instance is be created using the specified version. In the case of an existing database cluster, the operator will aptempt to upgrade or downgrade to the specified `controlPlaneAgentsVersion`. The field `status.currentControlPlaneAgentsVersion` indicates the current version for control plane agents. |
| `databaseImage` *string* | DatabaseImage is the URI of a customized database image within the container registry, for example, "gcr.io/foo/bar/alloydbomni:15-7-2-customized". This field is optional. If `databaseImage` is specified, then the operator uses this container image for the database instead of the default database container image of the specified `databaseVersion`. We recommend that the `databaseImage` container will be based on the default database image used of the chosen `databaseVersion`. |
| `primarySpec` *[PgInstanceSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#pginstancespec)* |   |

### DBClusterStatus

DBClusterStatus defines the observed state of DBCluster

*Appears in:*
- [DBCluster](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#dbcluster)

| Field | Description |
|---|---|
| `observedGeneration` *integer* | Internal: The generation observed by the controller. |
| `reconciled` *boolean* | Internal: Whether the resource was reconciled by the controller. |
| `criticalIncidents` *[CriticalIncident](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#criticalincident) array* | CriticalIncidents is a flat list of all active Critical Incidents. |
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array* | Conditions represents the latest available observations of the Entity's current state. |
| `phase` *[DBClusterPhase](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#dbclusterphase)* |   |
| `primary` *[PrimaryStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#primarystatus)* | Primary contains the status of the primary Instance. |
| `restoredFrom` *[RestoredFrom](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#restoredfrom)* |   |
| `upgradeScheduledAt` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | UpgradeScheduledAt is a timestamp that indicates when the next upgrade is scheduled to start. If it is nil, it means there is no upcoming upgrade scheduled. nullon(samwise-fleet) |
| `serviceAccounts` *object (keys:[OpType](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#optype), values:[ServiceAccountRef](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#serviceaccountref))* | ServiceAccounts contains the service accounts created by the control plane to be used by different operations. By granting permissions to these service accounts, the database can interact with other services within the kubernetes ecosystem. For further information, including what permissions is required, refer to the documentation of each operation. |
| `certificateReference` *[CertificateRef](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#certificateref)* | CertificateReference refers to a secret and a key of the server CA certificate that can be used to connect to the database. If `spec.TLS` is provided, this value should refer to the same secret after the database has been configured to use the provided server certificate. |
| `tls` *[TLSStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#tlsstatus)* | TLS is the current server certificate configuration for the database cluster. |
| `latestFailoverStatus` *[FailoverStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#failoverstatus)* | LatestFailoverStatus is the status of the most recently updated failover for the database cluster This status is a copy of the status of the current or most recently updated failover operation for the database cluster. This can be used to conveniently monitor the status of a currently running failover operation. |
| `migrationStatus` *[MigrationStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#migrationstatus)* | MigrationStatus represents the status of migration for the database cluster. nullon(samwise-fleet) |
| `availabilityZones` *[AvailabilityZones](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#availabilityzones)* | AvailabilityZones represents the zone status for a multi-zone HA database cluster. |
| `previousAvailabilityZones` *[AvailabilityZones](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#availabilityzones)* | PreviousAvailabilityZones represents the zone status for a multi-zone HA database cluster before a HA operation. |

### DeleteStandbyJob

DeleteStandbyJob is an internal workflow tracking object. Users should not directly interact with this.

*Appears in:*
- [DeleteStandbyJobList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#deletestandbyjoblist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `DeleteStandbyJob` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[WorkflowSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#workflowspec)* |   |
| `status` *[EntityStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#entitystatus)* |   |

### DeleteStandbyJobList

DeleteStandbyJobList contains a list of DeleteStandbyJobs

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `DeleteStandbyJobList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[DeleteStandbyJob](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#deletestandbyjob) array* |   |

### Export

Export is the Schema for the export API.

*Appears in:*
- [ExportList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#exportlist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `Export` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[ExportSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#exportspec)* |   |
| `status` *[ExportStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#exportstatus)* |   |

### ExportList

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `ExportList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[Export](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#export) array* |   |

### ExportSpec

ExportSpec defines the desired state of Export.

*Appears in:*
- [Export](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#export)

| Field | Description |
|---|---|
| `dbclusterRef` *DBClusterRef* | DBClusterRef is the dbcluster name within the same namespace to export from. |
| `exportLocation` *[StorageSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#storagespec)* | ExportLocation specifies a storage location for the export files. A user is to ensure proper write access to the storage bucket from within the Operator. |

### ExportStatus

ExportStatus defines the observed state of Export.

*Appears in:*
- [Export](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#export)

| Field | Description |
|---|---|
| `observedGeneration` *integer* | Internal: The generation observed by the controller. |
| `reconciled` *boolean* | Internal: Whether the resource was reconciled by the controller. |
| `criticalIncidents` *[CriticalIncident](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#criticalincident) array* | CriticalIncidents is a flat list of all active Critical Incidents. |
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array* | Conditions represents the latest available observations of the Entity's current state. |
| `phase` *[ExportPhase](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#exportphase)* | Phase is a summary of current state of the export. |
| `startTime` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | StartTime is the time export started. |
| `completeTime` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | CompleteTime is the time export completed. |
| `exportSubDirectory` *string* | ExportSubDirectory is the subdirectory appended to ExportLocation to store exported files. |

### ExternalServer

ExternalServer is the Schema for the ExternalServer API.

*Appears in:*
- [ExternalServerList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#externalserverlist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `ExternalServer` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[ExternalServerSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#externalserverspec)* |   |
| `status` *[ExternalServerStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#externalserverstatus)* |   |

### ExternalServerList

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `ExternalServerList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[ExternalServer](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#externalserver) array* |   |

### ExternalServerSpec

ExternalServerSpec defines metadata of an external database server used for migration.

*Appears in:*
- [ExternalServer](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#externalserver)

| Field | Description |
|---|---|
| `host` *string* | Host is the host ip of the external database server. |
| `port` *integer* | Port is the port of the external database server. |
| `username` *string* | UserName is the name of the user used to connect to the external database. |
| `password` *[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretreference-v1-core)* | Password is the reference to the secret storing external database server password. |
| `certRef` *[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretreference-v1-core)* | CertRef is the reference to the secret storing external database server certificate. |

### ExternalServerStatus

*Appears in:*
- [ExternalServer](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#externalserver)

| Field | Description |
|---|---|
| `observedGeneration` *integer* | Internal: The generation observed by the controller. |
| `reconciled` *boolean* | Internal: Whether the resource was reconciled by the controller. |
| `criticalIncidents` *[CriticalIncident](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#criticalincident) array* | CriticalIncidents is a flat list of all active Critical Incidents. |
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array* | Conditions represents the latest available observations of the Entity's current state. |

### Import

Import is the Schema for the import API.

*Appears in:*
- [ImportList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#importlist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `Import` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[ImportSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#importspec)* |   |
| `status` *[ImportStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#importstatus)* |   |

### ImportList

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `ImportList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[Import](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#import) array* |   |

### ImportSpec

ImportSpec defines the desired state of Import.

*Appears in:*
- [Import](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#import)

| Field | Description |
|---|---|
| `dbclusterRef` *DBClusterRef* | DBClusterRef is the dbcluster name within the same namespace to import into. |
| `databaseName` *string* | DatabaseName is the database resource name within Instance to import into. |
| `dumpStorage` *[StorageSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#storagespec)* | DumpStorage specifies a storage location for the import dump files. A user is to ensure proper read access to the storage bucket from within the Operator. |
| `logStorage` *[StorageSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#storagespec)* | LogStorage optionally specifies a storage location to copy import log to. A user is to ensure proper write access to the storage bucket from within the Operator. |
| `downloadOnly` *boolean* | DownloadOnly when set to true means dump file will be downloaded but not imported into DB. Default is false. |
| `tableExistAction` *string* | TableExistAction is the action to take when importing into an existing table. The default is to skip. |

### ImportStatus

ImportStatus defines the observed state of Import.

*Appears in:*
- [Import](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#import)

| Field | Description |
|---|---|
| `observedGeneration` *integer* | Internal: The generation observed by the controller. |
| `reconciled` *boolean* | Internal: Whether the resource was reconciled by the controller. |
| `criticalIncidents` *[CriticalIncident](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#criticalincident) array* | CriticalIncidents is a flat list of all active Critical Incidents. |
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array* | Conditions represents the latest available observations of the Entity's current state. |
| `phase` *[ImportPhase](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#importphase)* | Phase is a summary of current state of the import. |
| `startTime` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | StartTime is the time import started. |
| `completeTime` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | CompleteTime is the time import completed. |
| `dumpPath` *string* | DumpPath is the path of the downloaded dump file for download only import. |

### Migration

Migration is the Schema for the migration API.

*Appears in:*
- [MigrationList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#migrationlist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `Migration` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[MigrationSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#migrationspec)* |   |
| `status` *[MigrationStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#migrationstatus)* |   |

### MigrationList

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `MigrationList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[Migration](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#migration) array* |   |

### MigrationSpec

MigrationSpec defines the spec of the migration job.

*Appears in:*
- [Migration](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#migration)

| Field | Description |
|---|---|
| `source` *[SourceDatabaseServer](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#sourcedatabaseserver)* | Source is a database server that acts as the source for migration. |
| `target` *[TargetDatabaseServer](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#targetdatabaseserver)* | Target is a database server that acts as the target of migration. |
| `control` *MigrationControl* | Control is used to control the state of a migration job. |

### MigrationStatus

MigrationStatus defines the status of the migration job.

*Appears in:*
- [Migration](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#migration)

| Field | Description |
|---|---|
| `observedGeneration` *integer* | Internal: The generation observed by the controller. |
| `reconciled` *boolean* | Internal: Whether the resource was reconciled by the controller. |
| `criticalIncidents` *[CriticalIncident](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#criticalincident) array* | CriticalIncidents is a flat list of all active Critical Incidents. |
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array* | Conditions represents the latest available observations of the Entity's current state. |

### PgInstanceSpec

*Appears in:*
- [DBClusterSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#dbclusterspec)

| Field | Description |
|---|---|
| `version` *string* | Version of a database. nullon(samwise-fleet,samwise-local) |
| `images` *object (keys:string, values:string)* | Deprecated: Replacement images for the database instance. nullon(samwise-fleet,samwise-local) |
| `port` *integer* | Port is the port number that the database is listening on. nullon(dbs-fleet,dbs-local) |
| `component` *object (keys:[InstanceComponentName](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#instancecomponentname), values:[InstanceComponentSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#instancecomponentspec))* | The list of instance components An instance is composed of dataplane and controlPlaneAgent components |
| `dbLoadBalancerOptions` *[DBLoadBalancerOptions](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#dbloadbalanceroptions)* | DBNetworkServiceOptions allows to override some details of kubernetes Service created to expose a connection to database. |
| `sourceCidrRanges` *string array* | Source IP CIDR ranges allowed for a client. |
| `parameters` *object (keys:string, values:string)* | Parameters allows to set database parameters for the database cluster. This field is optional. Parameters will take a key/value pair corresponding to the parameter name/value as defined by the database engine. |
| `services` *object (keys:[Service](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#service), values:boolean)* | Services list the optional semi-managed services that the customers can choose from. |
| `resources` *[Resource](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#resource)* | Resource specification for the database container. When any of the fields inside the resource changes, the operator restarts the database instance with the new resource specification. |
| `mode` *[InstanceMode](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#instancemode)* | Mode specifies how this instance will be managed by the operator. |
| `databasePatchingTimeout` *[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#duration-v1-meta)* | The maximum duration allowed for patching the StatefulSet during container image updates. This threshold ensures that the database pods are updated within a specific time frame. If this field is unset, it will fall back to using the default maximum duration. |
| `adminUser` *[AdminUserSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#adminuserspec)* | AdminUser represents the admin user specification. This field is required. This is the initial database user that the control plane creates. Additional database users are managed by the end-user directly. This field can also be used to reset the password of the initial user. |
| `systemUserPasswordRefs` *object (keys:string, values:string)* | SystemUserPasswordRefs is a list of system users and the corresponding secrets containing the password for those accounts nullon(dbs-fleet,dbs-local) |
| `isStopped` *boolean* | IsStopped stops the instance when set to true. This field is optional and default to false. When stopped, the compute resources (CPU, memory) of the instance are released. However, the instance still keeps the storage resource and network endpoints so that restarting is transparent to the downstream services. See the status field for success or failures, if any. |
| `availabilityOptions` *[AvailabilityOptions](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#availabilityoptions)* | AvailabilityOptions contains adjustable settings for HA features |
| `allowExternalIncomingTrafficToInstance` *boolean* |   |
| `auditLogTarget` *[AuditLogTargetSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#auditlogtargetspec)* | AuditLogTarget configures the sink for the database audit logs |
| `replication` *[ReplicationSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#replicationspec)* | Replication configures replication connections to other db instances nullon(samwise-fleet) |
| `tls` *[TLSSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#tlsspec)* | TLS is the desired server certificate configuration for the instance. This field is optional. When this field is changed, the instance pods will restart to load the specified certificate |
| `schedulingconfig` *[SchedulingConfig](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#schedulingconfig)* | SchedulingConfig specifies how the instance should be scheduled on Kubernetes nodes. When any field inside the scheduling config changes, it can lead to rescheduling of the k8s pod onto a different node based on the config. |

### Replication

Replication is the Schema for the Replications API

*Appears in:*
- [ReplicationList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#replicationlist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `Replication` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[ReplicationSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#replicationspec)* |   |
| `status` *[ReplicationStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#replicationstatus)* |   |

### ReplicationList

ReplicationList contains a list of Replication

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `ReplicationList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[Replication](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#replication) array* |   |

### ReplicationSpec

ReplicationSpec defines the desired state of Replication

*Appears in:*
- [Replication](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#replication)

| Field | Description |
|---|---|
| `dbcluster` *[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#localobjectreference-v1-core)* | DBCluster is the DBCluster this Replication belongs to. |
| `upstream` *[UpstreamReplicationSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#upstreamreplicationspec)* | Upstream contains spec for replication upstream database. |
| `downstream` *[DownstreamReplicationSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#downstreamreplicationspec)* | Downstream contains spec for replication downstream database. |

### ReplicationStatus

ReplicationStatus defines the observed state of Replication

*Appears in:*
- [Replication](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#replication)

| Field | Description |
|---|---|
| `observedGeneration` *integer* | Internal: The generation observed by the controller. |
| `reconciled` *boolean* | Internal: Whether the resource was reconciled by the controller. |
| `criticalIncidents` *[CriticalIncident](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#criticalincident) array* | CriticalIncidents is a flat list of all active Critical Incidents. |
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array* | Conditions represents the latest available observations of the Entity's current state. |
| `upstream` *[UpstreamReplicationStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#upstreamreplicationstatus)* | Upstream contains observed state of replication upstream database. |
| `downstream` *[DownstreamReplicationStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#downstreamreplicationstatus)* | Downstream contains observed state of replication downstream database. |

### Restore

Restore is the Schema for the restores API

*Appears in:*
- [RestoreList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#restorelist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `Restore` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[RestoreSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#restorespec)* |   |
| `status` *[RestoreStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#restorestatus)* |   |

### RestoreList

RestoreList contains a list of Restores

| Field | Description |
|---|---|
| `apiVersion` *string* | `postgresql.dbadmin.gdc.goog/v1` |
| `kind` *string* | `RestoreList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[Restore](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#restore) array* |   |

### RestoreSpec

RestoreSpec defines the desired state of Restore.

*Appears in:*
- [Restore](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#restore)

| Field | Description |
|---|---|
| `sourceDBCluster` *DBClusterRef* | The name of the source DBCluster to restore from. This field is required. |
| `pointInTime` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | Previous point in time to restore to. This field is optional. Default to restore the latest available time point if not specified. |
| `clonedDBClusterConfig` *[ClonedDBClusterConfig](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#cloneddbclusterconfig)* | Settings for the cloned DBCluster. This lets you specify the name for the cloned DBCluster. This field is optional. Default to restore the source DBCluster if not specified. |

### RestoreStatus

RestoreStatus defines the observed state of Restore.

*Appears in:*
- [Restore](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#restore)

| Field | Description |
|---|---|
| `observedGeneration` *integer* | Internal: The generation observed by the controller. |
| `reconciled` *boolean* | Internal: Whether the resource was reconciled by the controller. |
| `criticalIncidents` *[CriticalIncident](https://docs.cloud.google.com/distributed-cloud/hosted/docs/1.16/gdcag/apis/service/dbs/v1/postgres-v1#criticalincident) array* | CriticalIncidents is a flat list of all active Critical Incidents. |
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array* | Conditions represents the latest available observations of the Entity's current state. |
| `phase` *RestorePhase* |   |
| `createTime` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | Creation time of the Restore |
| `completeTime` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | Completion time of the Restore |
| `restoredPointInTime` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | Actual point-in-time this restore brings the target DBCluster into. Might be different from value specified in spec.PointInTime. nullon(samwise-fleet) |