datawarehouse

type API struct {
	// contains filtered or unexported fields
}

type CreateDatabaseRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// DeploymentID: UUID of the deployment.
	DeploymentID string `json:"-"`

	// Name: name of the database.
	Name string `json:"name"`
}

type CreateDeploymentRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// ProjectID: the Project ID on which the deployment will be created.
	ProjectID string `json:"project_id"`

	// Name: name of the deployment.
	Name string `json:"name"`

	// Tags: tags to apply to the deployment.
	Tags []string `json:"tags"`

	// Version: clickHouse® version to use for the deployment.
	Version string `json:"version"`

	// ReplicaCount: number of replicas for the deployment.
	ReplicaCount uint32 `json:"replica_count"`

	// Password: password for the initial user.
	Password string `json:"password"`

	// CPUMin: minimum CPU count for the deployment.
	CPUMin uint32 `json:"cpu_min"`

	// CPUMax: maximum CPU count for the deployment.
	CPUMax uint32 `json:"cpu_max"`

	// Endpoints: endpoints to associate with the deployment.
	Endpoints []*EndpointSpec `json:"endpoints"`

	// RAMPerCPU: RAM per CPU count for the deployment (in GB).
	RAMPerCPU uint32 `json:"ram_per_cpu"`
}

type CreateEndpointRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// DeploymentID: UUID of the deployment.
	DeploymentID string `json:"deployment_id"`

	// Endpoint: endpoint specification.
	Endpoint *EndpointSpec `json:"endpoint,omitempty"`
}

type CreateUserRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// DeploymentID: UUID of the deployment.
	DeploymentID string `json:"-"`

	// Name: name of the user.
	Name string `json:"name"`

	// Password: password for the user.
	Password string `json:"password"`

	// IsAdmin: indicates if the user is an administrator.
	IsAdmin bool `json:"is_admin"`
}

type Database struct {
	// Name: name of the database.
	Name string `json:"name"`

	// Size: size of the database.
	Size scw.Size `json:"size"`
}

type DeleteDatabaseRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// DeploymentID: UUID of the deployment.
	DeploymentID string `json:"-"`

	// Name: name of the database to delete.
	Name string `json:"-"`
}

type DeleteDeploymentRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// DeploymentID: UUID of the deployment to delete.
	DeploymentID string `json:"-"`
}

type DeleteEndpointRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// EndpointID: UUID of the Endpoint to delete.
	EndpointID string `json:"-"`
}

type DeleteUserRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// DeploymentID: UUID of the deployment.
	DeploymentID string `json:"-"`

	// Name: name of the user to delete.
	Name string `json:"-"`
}

type Deployment struct {
	// ID: unique identifier.
	ID string `json:"id"`

	// Name: name of the deployment.
	Name string `json:"name"`

	// OrganizationID: organization ID.
	OrganizationID string `json:"organization_id"`

	// ProjectID: project ID.
	ProjectID string `json:"project_id"`

	// Status: status of the deployment.
	// Default value: unknown_status
	Status DeploymentStatus `json:"status"`

	// Tags: list of tags applied to the deployment.
	Tags []string `json:"tags"`

	// CreatedAt: creation date of the deployment.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: last modification date of the deployment.
	UpdatedAt *time.Time `json:"updated_at"`

	// Version: clickHouse® version.
	Version string `json:"version"`

	// ReplicaCount: number of replicas for the deployment.
	ReplicaCount uint32 `json:"replica_count"`

	// CPUMin: minimum CPU count for the deployment.
	CPUMin uint32 `json:"cpu_min"`

	// CPUMax: maximum CPU count for the deployment.
	CPUMax uint32 `json:"cpu_max"`

	// Endpoints: list of endpoints associated with the deployment.
	Endpoints []*Endpoint `json:"endpoints"`

	// RAMPerCPU: RAM per CPU count for the deployment (in GB).
	RAMPerCPU uint32 `json:"ram_per_cpu"`

	// Region: region of the deployment.
	Region scw.Region `json:"region"`
}

type DeploymentStatus string

type Endpoint struct {
	// ID: unique identifier of the endpoint.
	ID string `json:"id"`

	// DNSRecord: DNS record associated with the endpoint.
	DNSRecord string `json:"dns_record"`

	// Services: list of services associated with the endpoint.
	Services []*EndpointService `json:"services"`

	// PrivateNetwork: private Network endpoint details.
	// Precisely one of PrivateNetwork, Public must be set.
	PrivateNetwork *EndpointPrivateNetworkDetails `json:"private_network,omitempty"`

	// Public: public endpoint details.
	// Precisely one of PrivateNetwork, Public must be set.
	Public *EndpointPublicDetails `json:"public,omitempty"`
}

type EndpointPrivateNetworkDetails struct {
	PrivateNetworkID string `json:"private_network_id"`
}

type EndpointPublicDetails struct{}

type EndpointService struct {
	// Protocol: default value: unknown_protocol
	Protocol EndpointServiceProtocol `json:"protocol"`

	Port uint32 `json:"port"`
}

type EndpointServiceProtocol string

type EndpointSpec struct {
	// Precisely one of Public, PrivateNetwork must be set.
	Public *EndpointSpecPublicDetails `json:"public,omitempty"`

	// Precisely one of Public, PrivateNetwork must be set.
	PrivateNetwork *EndpointSpecPrivateNetworkDetails `json:"private_network,omitempty"`
}

type EndpointSpecPrivateNetworkDetails struct {
	// PrivateNetworkID: UUID of the Private Network.
	PrivateNetworkID string `json:"private_network_id"`
}

type EndpointSpecPublicDetails struct{}

type GetDeploymentCertificateRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	DeploymentID string `json:"-"`
}

type GetDeploymentRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// DeploymentID: UUID of the deployment.
	DeploymentID string `json:"-"`
}

type ListDatabasesRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// DeploymentID: UUID of the deployment.
	DeploymentID string `json:"-"`

	// Name: name of the database to filter by.
	Name *string `json:"-"`

	// OrderBy: criteria to use when ordering database listings.
	// Default value: name_asc
	OrderBy ListDatabasesRequestOrderBy `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
}

type ListDatabasesRequestOrderBy string

type ListDatabasesResponse struct {
	// Databases: list of databases associated with the deployment.
	Databases []*Database `json:"databases"`

	// TotalCount: total count of databases associated with the deployment.
	TotalCount uint32 `json:"total_count"`
}

type ListDeploymentsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// Tags: list deployments with a given tag.
	Tags []string `json:"-"`

	// Name: lists deployments that match a name pattern.
	Name *string `json:"-"`

	// OrderBy: criteria to use when ordering deployment listings.
	// Default value: created_at_desc
	OrderBy ListDeploymentsRequestOrderBy `json:"-"`

	// OrganizationID: organization ID the deployment belongs to.
	OrganizationID *string `json:"-"`

	// ProjectID: project ID the deployment belongs to.
	ProjectID *string `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
}

type ListDeploymentsRequestOrderBy string

type ListDeploymentsResponse struct {
	// Deployments: list of all deployments available in an Organization or Project.
	Deployments []*Deployment `json:"deployments"`

	// TotalCount: total count of deployments available in an Organization or Project.
	TotalCount uint64 `json:"total_count"`
}

type ListPresetsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
}

type ListPresetsResponse struct {
	// Presets: list of available presets.
	Presets []*Preset `json:"presets"`

	// TotalCount: total count of presets available.
	TotalCount uint64 `json:"total_count"`
}

type ListUsersRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// DeploymentID: UUID of the deployment.
	DeploymentID string `json:"-"`

	// Name: name of the user to filter by.
	Name *string `json:"-"`

	// OrderBy: criteria to use when ordering user listings.
	// Default value: name_asc
	OrderBy ListUsersRequestOrderBy `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
}

type ListUsersRequestOrderBy string

type ListUsersResponse struct {
	// Users: list of users associated with the deployment.
	Users []*User `json:"users"`

	// TotalCount: total count of users associated with the deployment.
	TotalCount uint64 `json:"total_count"`
}

type ListVersionsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	Version *string `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`
}

type ListVersionsResponse struct {
	// Versions: available deployment version.
	Versions []*Version `json:"versions"`

	// TotalCount: total count of deployment version available.
	TotalCount uint64 `json:"total_count"`
}

type Preset struct {
	// Name: name of the preset.
	Name string `json:"name"`

	// Category: category of the preset.
	Category string `json:"category"`

	// CPUMin: minimum CPU count for the preset.
	CPUMin uint32 `json:"cpu_min"`

	// CPUMax: maximum CPU count for the preset.
	CPUMax uint32 `json:"cpu_max"`

	// RAMPerCPU: RAM per CPU count for the preset (in GB).
	RAMPerCPU uint32 `json:"ram_per_cpu"`

	// ReplicaCount: number of replicas for the preset.
	ReplicaCount uint32 `json:"replica_count"`
}

type UpdateDeploymentRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// DeploymentID: UUID of the deployment to update.
	DeploymentID string `json:"-"`

	// Name: name of the deployment.
	Name *string `json:"name,omitempty"`

	// Tags: tags of a deployment.
	Tags *[]string `json:"tags,omitempty"`

	// CPUMin: minimum CPU count for the deployment.
	CPUMin *uint32 `json:"cpu_min,omitempty"`

	// CPUMax: maximum CPU count for the deployment.
	CPUMax *uint32 `json:"cpu_max,omitempty"`

	// ReplicaCount: number of replicas for the deployment.
	ReplicaCount *uint32 `json:"replica_count,omitempty"`
}

type UpdateUserRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// DeploymentID: UUID of the deployment.
	DeploymentID string `json:"-"`

	// Name: name of the user.
	Name string `json:"-"`

	// Password: new password for the user.
	Password *string `json:"password,omitempty"`

	// IsAdmin: updates the user administrator permissions.
	IsAdmin *bool `json:"is_admin,omitempty"`
}

type User struct {
	// Name: name of the user.
	Name string `json:"name"`

	// IsAdmin: indicates if the user is an administrator.
	IsAdmin bool `json:"is_admin"`
}

type Version struct {
	// Version: deployment version.
	Version string `json:"version"`

	// EndOfLifeAt: date of End of Life.
	EndOfLifeAt *time.Time `json:"end_of_life_at"`
}

type WaitForDeploymentRequest struct {
	DeploymentID  string
	Region        scw.Region
	Timeout       *time.Duration
	RetryInterval *time.Duration
}