views

type BackupConfigSpecView struct {
	// The repositories for this backup configuration.
	Repositories []*BackupRepositorySpecView
	// The schedules for this backup configuration.
	Schedules []*BackupScheduleSpecView
}

type BackupRepositorySpecView struct {
	// The unique identifier of this repository.
	ID *IdentifierView
	// The type of this repository.
	Type *string
	// The S3 bucket name for this repository. Only applies when type = 's3'.
	S3Bucket *string
	// The region of the S3 bucket for this repository. Only applies when type =
	// 's3'.
	S3Region *string
	// The optional S3 endpoint for this repository. Only applies when type = 's3'.
	S3Endpoint *string
	// An optional AWS access key ID to use for this repository. If not provided,
	// pgbackrest will use the default credential provider chain. This field will
	// be excluded from the response of all endpoints. It can also be omitted from
	// update requests to keep the current value.
	S3Key *string
	// The corresponding secret for the AWS access key ID in s3_key. This field
	// will be excluded from the response of all endpoints. It can also be omitted
	// from update requests to keep the current value.
	S3KeySecret *string
	// The GCS bucket name for this repository. Only applies when type = 'gcs'.
	GcsBucket *string
	// The optional GCS endpoint for this repository. Only applies when type =
	// 'gcs'.
	GcsEndpoint *string
	// Optional base64-encoded private key data. If omitted, pgbackrest will use
	// the service account attached to the instance profile. This field will be
	// excluded from the response of all endpoints. It can also be omitted from
	// update requests to keep the current value.
	GcsKey *string
	// The Azure account name for this repository. Only applies when type = 'azure'.
	AzureAccount *string
	// The Azure container name for this repository. Only applies when type =
	// 'azure'.
	AzureContainer *string
	// The optional Azure endpoint for this repository. Only applies when type =
	// 'azure'.
	AzureEndpoint *string
	// The Azure storage account access key to use for this repository. This field
	// will be excluded from the response of all endpoints. It can also be omitted
	// from update requests to keep the current value.
	AzureKey *string
	// The count of full backups to retain or the time to retain full backups.
	RetentionFull *int
	// The type of measure used for retention_full.
	RetentionFullType *string
	// The base path within the repository to store backups. Required for type =
	// 'posix' and 'cifs'.
	BasePath *string
	// Additional options to apply to this repository.
	CustomOptions map[string]string
}

type BackupScheduleSpecView struct {
	// The unique identifier for this backup schedule.
	ID *string
	// The type of backup to take on this schedule.
	Type *string
	// The cron expression for this schedule.
	CronExpression *string
}

type CreateDatabaseResponseView struct {
	// The task that will create this database.
	Task *TaskView
	// The database being created.
	Database *DatabaseView
}

type Database struct {
	// Type to project
	Projected *DatabaseView
	// View to render
	View string
}

type DatabaseCollectionView []*DatabaseView

type DatabaseNodeSpecView struct {
	// The name of the database node.
	Name *string
	// The IDs of the hosts that should run this node. When multiple hosts are
	// specified, one host will chosen as a primary, and the others will be read
	// replicas.
	HostIds []IdentifierView
	// The Postgres version for this node in 'major.minor' format. Overrides the
	// Postgres version set in the DatabaseSpec.
	PostgresVersion *string
	// The port used by the Postgres database for this node. Overrides the Postgres
	// port set in the DatabaseSpec.
	Port *int
	// The number of CPUs to allocate for the database on this node and to use for
	// tuning Postgres. It can include the SI suffix 'm', e.g. '500m' for 500
	// millicpus. Cannot allocate units smaller than 1m. Defaults to the number of
	// available CPUs on the host if 0 or unspecified. Cannot allocate more CPUs
	// than are available on the host. Whether this limit is enforced depends on
	// the orchestrator.
	Cpus *string
	// The amount of memory in SI or IEC notation to allocate for the database on
	// this node and to use for tuning Postgres. Defaults to the total available
	// memory on the host. Whether this limit is enforced depends on the
	// orchestrator.
	Memory *string
	// Additional postgresql.conf settings for this particular node. Will be merged
	// with the settings provided by control-plane.
	PostgresqlConf map[string]any
	// The backup configuration for this node. Overrides the backup configuration
	// set in the DatabaseSpec.
	BackupConfig *BackupConfigSpecView
	// The restore configuration for this node. Overrides the restore configuration
	// set in the DatabaseSpec.
	RestoreConfig *RestoreConfigSpecView
	// Orchestrator-specific configuration options.
	OrchestratorOpts *OrchestratorOptsView
	// The name of the source node to use for sync. This is typically the node
	// (like 'n1') from which the data will be copied to initialize this new node.
	SourceNode *string
}

type DatabaseSpecView struct {
	// The name of the Postgres database.
	DatabaseName *string
	// The Postgres version in 'major.minor' format.
	PostgresVersion *string
	// The major version of the Spock extension.
	SpockVersion *string
	// The port used by the Postgres database. If the port is 0, each instance will
	// be assigned a random port. If the port is unspecified, the database will not
	// be exposed on any port, dependent on orchestrator support for that feature.
	Port *int
	// The number of CPUs to allocate for the database and to use for tuning
	// Postgres. Defaults to the number of available CPUs on the host. Can include
	// an SI suffix, e.g. '500m' for 500 millicpus. Whether this limit is enforced
	// depends on the orchestrator.
	Cpus *string
	// The amount of memory in SI or IEC notation to allocate for the database and
	// to use for tuning Postgres. Defaults to the total available memory on the
	// host. Whether this limit is enforced depends on the orchestrator.
	Memory *string
	// The Spock nodes for this database.
	Nodes []*DatabaseNodeSpecView
	// The users to create for this database.
	DatabaseUsers []*DatabaseUserSpecView
	// The backup configuration for this database.
	BackupConfig *BackupConfigSpecView
	// The restore configuration for this database.
	RestoreConfig *RestoreConfigSpecView
	// Additional postgresql.conf settings. Will be merged with the settings
	// provided by control-plane.
	PostgresqlConf map[string]any
	// Orchestrator-specific configuration options.
	OrchestratorOpts *OrchestratorOptsView
}

type DatabaseUserSpecView struct {
	// The username for this database user.
	Username *string
	// The password for this database user. This field will be excluded from the
	// response of all endpoints. It can also be omitted from update requests to
	// keep the current value.
	Password *string
	// If true, this user will be granted database ownership.
	DbOwner *bool
	// The attributes to assign to this database user.
	Attributes []string
	// The roles to assign to this database user.
	Roles []string
}

type DatabaseView struct {
	// Unique identifier for the database.
	ID *IdentifierView
	// Unique identifier for the databases's owner.
	TenantID *IdentifierView
	// The time that the database was created.
	CreatedAt *string
	// The time that the database was last updated.
	UpdatedAt *string
	// Current state of the database.
	State *string
	// All of the instances in the database.
	Instances InstanceCollectionView
	// The user-provided specification for the database.
	Spec *DatabaseSpecView
}

type ExtraNetworkSpecView struct {
	// The name or ID of the network to connect to.
	ID *string
	// Optional network-scoped aliases for the container.
	Aliases []string
	// Optional driver options for the network connection.
	DriverOpts map[string]string
}

type ExtraVolumesSpecView struct {
	// The host path for the volume.
	HostPath *string
	// The path inside the container where the volume will be mounted.
	DestinationPath *string
}

type IdentifierView string

type InstanceCollectionView []*InstanceView

type InstanceConnectionInfoView struct {
	// The hostname of the host that's running this instance.
	Hostname *string
	// The IPv4 address of the host that's running this instance.
	Ipv4Address *string
	// The host port that Postgres is listening on for this instance.
	Port *int
}

type InstancePostgresStatusView struct {
	// The version of Postgres for this instance.
	Version      *string
	PatroniState *string
	Role         *string
	// True if this instance has a pending restart from a configuration change.
	PendingRestart *bool
	// True if Patroni is paused for this instance.
	PatroniPaused *bool
}

type InstanceSpockStatusView struct {
	// The current spock.readonly setting.
	ReadOnly *string
	// The version of Spock for this instance.
	Version *string
	// Status information for this instance's Spock subscriptions.
	Subscriptions []*InstanceSubscriptionView
}

type InstanceSubscriptionView struct {
	// The Spock node name of the provider for this subscription.
	ProviderNode *string
	// The name of the subscription.
	Name *string
	// The current status of the subscription.
	Status *string
}

type InstanceView struct {
	// Unique identifier for the instance.
	ID *string
	// The ID of the host this instance is running on.
	HostID *string
	// The Spock node name for this instance.
	NodeName *string
	// The time that the instance was created.
	CreatedAt *string
	// The time that the instance was last modified.
	UpdatedAt *string
	// The time that the instance status information was last updated.
	StatusUpdatedAt *string
	State           *string
	// Connection information for the instance.
	ConnectionInfo *InstanceConnectionInfoView
	// Postgres status information for the instance.
	Postgres *InstancePostgresStatusView
	// Spock status information for the instance.
	Spock *InstanceSpockStatusView
	// An error message if the instance is in an error state.
	Error *string
}

type ListDatabasesResponse struct {
	// Type to project
	Projected *ListDatabasesResponseView
	// View to render
	View string
}

type ListDatabasesResponseView struct {
	Databases DatabaseCollectionView
}

type OrchestratorOptsView struct {
	// Swarm-specific configuration.
	Swarm *SwarmOptsView
}

type RestoreConfigSpecView struct {
	// The ID of the database to restore this database from.
	SourceDatabaseID *IdentifierView
	// The name of the node to restore this database from.
	SourceNodeName *string
	// The name of the database in this repository. The database will be renamed to
	// the database_name in the DatabaseSpec after it's restored.
	SourceDatabaseName *string
	// The repository to restore this database from.
	Repository *RestoreRepositorySpecView
	// Additional options to use when restoring this database. If omitted, the
	// database will be restored to the latest point in the given repository.
	RestoreOptions map[string]string
}

type RestoreDatabaseResponseView struct {
	// The task that will restore this database.
	Task *TaskView
	// The tasks that will restore each database node.
	NodeTasks []*TaskView
	// The database being restored.
	Database *DatabaseView
}

type RestoreRepositorySpecView struct {
	// The unique identifier of this repository.
	ID *IdentifierView
	// The type of this repository.
	Type *string
	// The S3 bucket name for this repository. Only applies when type = 's3'.
	S3Bucket *string
	// The region of the S3 bucket for this repository. Only applies when type =
	// 's3'.
	S3Region *string
	// The optional S3 endpoint for this repository. Only applies when type = 's3'.
	S3Endpoint *string
	// An optional AWS access key ID to use for this repository. If not provided,
	// pgbackrest will use the default credential provider chain.
	S3Key *string
	// The corresponding secret for the AWS access key ID in s3_key.
	S3KeySecret *string
	// The GCS bucket name for this repository. Only applies when type = 'gcs'.
	GcsBucket *string
	// The optional GCS endpoint for this repository. Only applies when type =
	// 'gcs'.
	GcsEndpoint *string
	// Optional base64-encoded private key data. If omitted, pgbackrest will use
	// the service account attached to the instance profile.
	GcsKey *string
	// The Azure account name for this repository. Only applies when type = 'azure'.
	AzureAccount *string
	// The Azure container name for this repository. Only applies when type =
	// 'azure'.
	AzureContainer *string
	// The optional Azure endpoint for this repository. Only applies when type =
	// 'azure'.
	AzureEndpoint *string
	// An optional Azure storage account access key to use for this repository. If
	// not provided, pgbackrest will use the VM's managed identity.
	AzureKey *string
	// The base path within the repository to store backups. Required for type =
	// 'posix' and 'cifs'.
	BasePath *string
	// Additional options to apply to this repository.
	CustomOptions map[string]string
}

type SwarmOptsView struct {
	// A list of extra volumes to mount. Each entry defines a host and container
	// path.
	ExtraVolumes []*ExtraVolumesSpecView
	// A list of additional Docker Swarm networks to attach containers in this
	// database to.
	ExtraNetworks []*ExtraNetworkSpecView
	// Arbitrary labels to apply to the Docker Swarm service
	ExtraLabels map[string]string
}

type TaskView struct {
	// The parent task ID of the task.
	ParentID *string
	// The database ID of the task.
	DatabaseID *string
	// The name of the node that the task is operating on.
	NodeName *string
	// The ID of the instance that the task is operating on.
	InstanceID *string
	// The ID of the host that the task is running on.
	HostID *string
	// The unique ID of the task.
	TaskID *string
	// The time when the task was created.
	CreatedAt *string
	// The time when the task was completed.
	CompletedAt *string
	// The type of the task.
	Type *string
	// The status of the task.
	Status *string
	// The error message if the task failed.
	Error *string
}

type UpdateDatabaseResponseView struct {
	// The task that will update this database.
	Task *TaskView
	// The database being updated.
	Database *DatabaseView
}