api

package
v0.5.0-beta.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 25, 2026 License: PostgreSQL Imports: 12 Imported by: 0

Documentation

Overview

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.7.0 DO NOT EDIT.

Package api is the generated pgEdge Managed API client. Do not edit client.gen.go by hand; regenerate with `make generate`.

Index

Constants

View Source
const (
	AccessTokenScopes accessTokenContextKey = "AccessToken.Scopes"
)

Variables

This section is empty.

Functions

func NewCreateBackupRequest

func NewCreateBackupRequest(server string, id UUID, body CreateBackupJSONRequestBody) (*http.Request, error)

NewCreateBackupRequest calls the generic CreateBackup builder with application/json body

func NewCreateBackupRequestWithBody

func NewCreateBackupRequestWithBody(server string, id UUID, contentType string, body io.Reader) (*http.Request, error)

NewCreateBackupRequestWithBody generates requests for CreateBackup with any type of body

func NewCreateBranchRequest

func NewCreateBranchRequest(server string, id UUID, body CreateBranchJSONRequestBody) (*http.Request, error)

NewCreateBranchRequest calls the generic CreateBranch builder with application/json body

func NewCreateBranchRequestWithBody

func NewCreateBranchRequestWithBody(server string, id UUID, contentType string, body io.Reader) (*http.Request, error)

NewCreateBranchRequestWithBody generates requests for CreateBranch with any type of body

func NewCreateManagedDatabaseRequest

func NewCreateManagedDatabaseRequest(server string, body CreateManagedDatabaseJSONRequestBody) (*http.Request, error)

NewCreateManagedDatabaseRequest calls the generic CreateManagedDatabase builder with application/json body

func NewCreateManagedDatabaseRequestWithBody

func NewCreateManagedDatabaseRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateManagedDatabaseRequestWithBody generates requests for CreateManagedDatabase with any type of body

func NewDeleteBranchRequest

func NewDeleteBranchRequest(server string, id UUID, branchId UUID) (*http.Request, error)

NewDeleteBranchRequest generates requests for DeleteBranch

func NewDeleteManagedDatabaseRequest

func NewDeleteManagedDatabaseRequest(server string, id UUID, params *DeleteManagedDatabaseParams) (*http.Request, error)

NewDeleteManagedDatabaseRequest generates requests for DeleteManagedDatabase

func NewGetBackupRequest

func NewGetBackupRequest(server string, id UUID) (*http.Request, error)

NewGetBackupRequest generates requests for GetBackup

func NewGetBranchLogsRequest

func NewGetBranchLogsRequest(server string, id UUID, branchId UUID, params *GetBranchLogsParams) (*http.Request, error)

NewGetBranchLogsRequest generates requests for GetBranchLogs

func NewGetBranchMetricsRequest

func NewGetBranchMetricsRequest(server string, id UUID, branchId UUID, params *GetBranchMetricsParams) (*http.Request, error)

NewGetBranchMetricsRequest generates requests for GetBranchMetrics

func NewGetBranchRequest

func NewGetBranchRequest(server string, id UUID, branchId UUID, params *GetBranchParams) (*http.Request, error)

NewGetBranchRequest generates requests for GetBranch

func NewGetManagedClientIPRequest

func NewGetManagedClientIPRequest(server string) (*http.Request, error)

NewGetManagedClientIPRequest generates requests for GetManagedClientIP

func NewGetManagedDatabaseLogsRequest

func NewGetManagedDatabaseLogsRequest(server string, id UUID, params *GetManagedDatabaseLogsParams) (*http.Request, error)

NewGetManagedDatabaseLogsRequest generates requests for GetManagedDatabaseLogs

func NewGetManagedDatabaseMetricsRequest

func NewGetManagedDatabaseMetricsRequest(server string, id UUID, params *GetManagedDatabaseMetricsParams) (*http.Request, error)

NewGetManagedDatabaseMetricsRequest generates requests for GetManagedDatabaseMetrics

func NewGetManagedDatabaseRequest

func NewGetManagedDatabaseRequest(server string, id UUID, params *GetManagedDatabaseParams) (*http.Request, error)

NewGetManagedDatabaseRequest generates requests for GetManagedDatabase

func NewGetManagedOpenApiSpecRequest

func NewGetManagedOpenApiSpecRequest(server string) (*http.Request, error)

NewGetManagedOpenApiSpecRequest generates requests for GetManagedOpenApiSpec

func NewGetManagedPublicOpenApiSpecRequest

func NewGetManagedPublicOpenApiSpecRequest(server string) (*http.Request, error)

NewGetManagedPublicOpenApiSpecRequest generates requests for GetManagedPublicOpenApiSpec

func NewGetSizeRequest

func NewGetSizeRequest(server string, id UUID) (*http.Request, error)

NewGetSizeRequest generates requests for GetSize

func NewListBackupsRequest

func NewListBackupsRequest(server string, params *ListBackupsParams) (*http.Request, error)

NewListBackupsRequest generates requests for ListBackups

func NewListBranchesRequest

func NewListBranchesRequest(server string, id UUID, params *ListBranchesParams) (*http.Request, error)

NewListBranchesRequest generates requests for ListBranches

func NewListManagedDatabasesRequest

func NewListManagedDatabasesRequest(server string, params *ListManagedDatabasesParams) (*http.Request, error)

NewListManagedDatabasesRequest generates requests for ListManagedDatabases

func NewListManagedPGVersionsRequest

func NewListManagedPGVersionsRequest(server string) (*http.Request, error)

NewListManagedPGVersionsRequest generates requests for ListManagedPGVersions

func NewListManagedRegionsRequest

func NewListManagedRegionsRequest(server string) (*http.Request, error)

NewListManagedRegionsRequest generates requests for ListManagedRegions

func NewListManagedTasksRequest

func NewListManagedTasksRequest(server string, params *ListManagedTasksParams) (*http.Request, error)

NewListManagedTasksRequest generates requests for ListManagedTasks

func NewListSizesRequest

func NewListSizesRequest(server string, params *ListSizesParams) (*http.Request, error)

NewListSizesRequest generates requests for ListSizes

func NewResizeManagedDatabaseRequest

func NewResizeManagedDatabaseRequest(server string, id UUID, body ResizeManagedDatabaseJSONRequestBody) (*http.Request, error)

NewResizeManagedDatabaseRequest calls the generic ResizeManagedDatabase builder with application/json body

func NewResizeManagedDatabaseRequestWithBody

func NewResizeManagedDatabaseRequestWithBody(server string, id UUID, contentType string, body io.Reader) (*http.Request, error)

NewResizeManagedDatabaseRequestWithBody generates requests for ResizeManagedDatabase with any type of body

func NewRestoreManagedDatabaseRequest

func NewRestoreManagedDatabaseRequest(server string, id UUID, body RestoreManagedDatabaseJSONRequestBody) (*http.Request, error)

NewRestoreManagedDatabaseRequest calls the generic RestoreManagedDatabase builder with application/json body

func NewRestoreManagedDatabaseRequestWithBody

func NewRestoreManagedDatabaseRequestWithBody(server string, id UUID, contentType string, body io.Reader) (*http.Request, error)

NewRestoreManagedDatabaseRequestWithBody generates requests for RestoreManagedDatabase with any type of body

func NewRotateManagedDatabaseRolePasswordRequest

func NewRotateManagedDatabaseRolePasswordRequest(server string, id UUID, roleName RotateManagedDatabaseRolePasswordParamsRoleName) (*http.Request, error)

NewRotateManagedDatabaseRolePasswordRequest generates requests for RotateManagedDatabaseRolePassword

func NewUpdateManagedDatabaseRequest

func NewUpdateManagedDatabaseRequest(server string, id UUID, body UpdateManagedDatabaseJSONRequestBody) (*http.Request, error)

NewUpdateManagedDatabaseRequest calls the generic UpdateManagedDatabase builder with application/json body

func NewUpdateManagedDatabaseRequestWithBody

func NewUpdateManagedDatabaseRequestWithBody(server string, id UUID, contentType string, body io.Reader) (*http.Request, error)

NewUpdateManagedDatabaseRequestWithBody generates requests for UpdateManagedDatabase with any type of body

Types

type Backup

type Backup struct {
	CreatedAt  time.Time  `json:"created_at"`
	DatabaseId string     `json:"database_id"`
	FinishedAt *time.Time `json:"finished_at,omitempty"`
	Id         string     `json:"id"`

	// Kind Backup tier: "hot" or "durable".
	Kind     string                 `json:"kind"`
	Metadata map[string]interface{} `json:"metadata"`
	Name     string                 `json:"name"`

	// Purpose What the backup was taken for. Current values: "user" (on-demand), "scheduled" (the daily run), "prebranch" (the snapshot a branch create cut against the source), "prerestore" (the rollback anchor taken before a restore), and "postrestore" (the anchor taken on the new incarnation after a restore). The set is open — new values may appear as operations gain provenance — so treat an unrecognized value as informational rather than an error. Absent when the provenance is unknown.
	Purpose *string `json:"purpose,omitempty"`

	// Status CNPG backup phase. Only "completed" backups are usable restore points.
	Status string `json:"status"`
}

Backup defines model for Backup.

type Branch

type Branch struct {
	// ConnectableAt When the branch first became connectable. The branch bills from this moment until its deletion is requested. Absent while the branch is still being created.
	ConnectableAt nullable.Nullable[string] `json:"connectable_at,omitempty"`
	Connection    *ManagedConnection        `json:"connection,omitempty"`
	CreatedAt     string                    `json:"created_at"`

	// DatabaseId The root database this branch was taken from, at any depth.
	DatabaseId string `json:"database_id"`

	// DeletionRequestedAt When deletion was requested; absent before then. Billing stops and the branch's slot frees here, ahead of teardown completing.
	DeletionRequestedAt nullable.Nullable[string] `json:"deletion_requested_at,omitempty"`

	// Depth 1 for a branch of the database.
	Depth int `json:"depth"`

	// DisplayName Display name of the branch. Absent if not set.
	DisplayName nullable.Nullable[string] `json:"display_name,omitempty"`
	Domain      *string                   `json:"domain,omitempty"`
	Id          string                    `json:"id"`

	// IpAllowlist Source addresses permitted to reach the branch's POSTGRES endpoint, with the posture the rules express. Each AI service's own endpoint reports its allowlist on its entry in services. Every branch allowlist is fixed at creation: it cannot be changed afterwards, and changes to the source database's lists never reach the branch. To change one, recreate the branch.
	IpAllowlist IPAllowlist `json:"ip_allowlist"`

	// Name Server-assigned name; also the branch's hostname label.
	Name    string    `json:"name"`
	Options *[]string `json:"options,omitempty"`

	// ParentBranchId The branch this branch was taken from. Absent when branched directly from the database.
	ParentBranchId nullable.Nullable[string] `json:"parent_branch_id,omitempty"`
	PgVersion      string                    `json:"pg_version"`

	// Port Externally reachable Postgres port.
	Port   *int   `json:"port,omitempty"`
	Region string `json:"region"`

	// Services AI services on the branch, copied from the source's configuration at creation with the branch's own secrets: each MCP service gets a freshly minted bearer token (the source's tokens never authenticate against the branch), returned as mcp_config.init_tokens on the single-branch GET, while the source's provider API keys are inherited so embedding and completion calls work as they do on the source. Like every branch property, the services are fixed at creation.
	Services *[]ServiceConfig `json:"services,omitempty"`

	// Size Managed size name, copied from the source at creation.
	Size      string `json:"size"`
	Status    string `json:"status"`
	UpdatedAt string `json:"updated_at"`
}

Branch defines model for Branch.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) CreateBackup

func (c *Client) CreateBackup(ctx context.Context, id UUID, body CreateBackupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateBackupWithBody

func (c *Client) CreateBackupWithBody(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateBranch

func (c *Client) CreateBranch(ctx context.Context, id UUID, body CreateBranchJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateBranchWithBody

func (c *Client) CreateBranchWithBody(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateManagedDatabase

func (c *Client) CreateManagedDatabase(ctx context.Context, body CreateManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateManagedDatabaseWithBody

func (c *Client) CreateManagedDatabaseWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteBranch

func (c *Client) DeleteBranch(ctx context.Context, id UUID, branchId UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteManagedDatabase

func (c *Client) DeleteManagedDatabase(ctx context.Context, id UUID, params *DeleteManagedDatabaseParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBackup

func (c *Client) GetBackup(ctx context.Context, id UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBranch

func (c *Client) GetBranch(ctx context.Context, id UUID, branchId UUID, params *GetBranchParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBranchLogs

func (c *Client) GetBranchLogs(ctx context.Context, id UUID, branchId UUID, params *GetBranchLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBranchMetrics

func (c *Client) GetBranchMetrics(ctx context.Context, id UUID, branchId UUID, params *GetBranchMetricsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetManagedClientIP

func (c *Client) GetManagedClientIP(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetManagedDatabase

func (c *Client) GetManagedDatabase(ctx context.Context, id UUID, params *GetManagedDatabaseParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetManagedDatabaseLogs

func (c *Client) GetManagedDatabaseLogs(ctx context.Context, id UUID, params *GetManagedDatabaseLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetManagedDatabaseMetrics

func (c *Client) GetManagedDatabaseMetrics(ctx context.Context, id UUID, params *GetManagedDatabaseMetricsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetManagedOpenApiSpec

func (c *Client) GetManagedOpenApiSpec(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetManagedPublicOpenApiSpec

func (c *Client) GetManagedPublicOpenApiSpec(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetSize

func (c *Client) GetSize(ctx context.Context, id UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListBackups

func (c *Client) ListBackups(ctx context.Context, params *ListBackupsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListBranches

func (c *Client) ListBranches(ctx context.Context, id UUID, params *ListBranchesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListManagedDatabases

func (c *Client) ListManagedDatabases(ctx context.Context, params *ListManagedDatabasesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListManagedPGVersions

func (c *Client) ListManagedPGVersions(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListManagedRegions

func (c *Client) ListManagedRegions(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListManagedTasks

func (c *Client) ListManagedTasks(ctx context.Context, params *ListManagedTasksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListSizes

func (c *Client) ListSizes(ctx context.Context, params *ListSizesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ResizeManagedDatabase

func (c *Client) ResizeManagedDatabase(ctx context.Context, id UUID, body ResizeManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ResizeManagedDatabaseWithBody

func (c *Client) ResizeManagedDatabaseWithBody(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RestoreManagedDatabase

func (c *Client) RestoreManagedDatabase(ctx context.Context, id UUID, body RestoreManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RestoreManagedDatabaseWithBody

func (c *Client) RestoreManagedDatabaseWithBody(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RotateManagedDatabaseRolePassword

func (c *Client) RotateManagedDatabaseRolePassword(ctx context.Context, id UUID, roleName RotateManagedDatabaseRolePasswordParamsRoleName, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateManagedDatabase

func (c *Client) UpdateManagedDatabase(ctx context.Context, id UUID, body UpdateManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateManagedDatabaseWithBody

func (c *Client) UpdateManagedDatabaseWithBody(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientIPAddress

type ClientIPAddress struct {
	// IpAddress The source address this request arrived with.
	IpAddress string `json:"ip_address"`
}

ClientIPAddress defines model for ClientIPAddress.

type ClientInterface

type ClientInterface interface {
	// ListBackups request
	ListBackups(ctx context.Context, params *ListBackupsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBackup request
	GetBackup(ctx context.Context, id UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetManagedClientIP request
	GetManagedClientIP(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListManagedDatabases request
	ListManagedDatabases(ctx context.Context, params *ListManagedDatabasesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateManagedDatabaseWithBody request with any body
	CreateManagedDatabaseWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateManagedDatabase(ctx context.Context, body CreateManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteManagedDatabase request
	DeleteManagedDatabase(ctx context.Context, id UUID, params *DeleteManagedDatabaseParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetManagedDatabase request
	GetManagedDatabase(ctx context.Context, id UUID, params *GetManagedDatabaseParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateManagedDatabaseWithBody request with any body
	UpdateManagedDatabaseWithBody(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateManagedDatabase(ctx context.Context, id UUID, body UpdateManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateBackupWithBody request with any body
	CreateBackupWithBody(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateBackup(ctx context.Context, id UUID, body CreateBackupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListBranches request
	ListBranches(ctx context.Context, id UUID, params *ListBranchesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateBranchWithBody request with any body
	CreateBranchWithBody(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateBranch(ctx context.Context, id UUID, body CreateBranchJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteBranch request
	DeleteBranch(ctx context.Context, id UUID, branchId UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBranch request
	GetBranch(ctx context.Context, id UUID, branchId UUID, params *GetBranchParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBranchLogs request
	GetBranchLogs(ctx context.Context, id UUID, branchId UUID, params *GetBranchLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBranchMetrics request
	GetBranchMetrics(ctx context.Context, id UUID, branchId UUID, params *GetBranchMetricsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetManagedDatabaseLogs request
	GetManagedDatabaseLogs(ctx context.Context, id UUID, params *GetManagedDatabaseLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetManagedDatabaseMetrics request
	GetManagedDatabaseMetrics(ctx context.Context, id UUID, params *GetManagedDatabaseMetricsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RestoreManagedDatabaseWithBody request with any body
	RestoreManagedDatabaseWithBody(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	RestoreManagedDatabase(ctx context.Context, id UUID, body RestoreManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RotateManagedDatabaseRolePassword request
	RotateManagedDatabaseRolePassword(ctx context.Context, id UUID, roleName RotateManagedDatabaseRolePasswordParamsRoleName, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ResizeManagedDatabaseWithBody request with any body
	ResizeManagedDatabaseWithBody(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ResizeManagedDatabase(ctx context.Context, id UUID, body ResizeManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetManagedOpenApiSpec request
	GetManagedOpenApiSpec(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetManagedPublicOpenApiSpec request
	GetManagedPublicOpenApiSpec(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListManagedPGVersions request
	ListManagedPGVersions(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListManagedRegions request
	ListManagedRegions(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSizes request
	ListSizes(ctx context.Context, params *ListSizesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSize request
	GetSize(ctx context.Context, id UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListManagedTasks request
	ListManagedTasks(ctx context.Context, params *ListManagedTasksParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) CreateBackupWithBodyWithResponse

func (c *ClientWithResponses) CreateBackupWithBodyWithResponse(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateBackupResponse, error)

CreateBackupWithBodyWithResponse request with arbitrary body returning *CreateBackupResponse

func (*ClientWithResponses) CreateBackupWithResponse

func (c *ClientWithResponses) CreateBackupWithResponse(ctx context.Context, id UUID, body CreateBackupJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateBackupResponse, error)

func (*ClientWithResponses) CreateBranchWithBodyWithResponse

func (c *ClientWithResponses) CreateBranchWithBodyWithResponse(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateBranchResponse, error)

CreateBranchWithBodyWithResponse request with arbitrary body returning *CreateBranchResponse

func (*ClientWithResponses) CreateBranchWithResponse

func (c *ClientWithResponses) CreateBranchWithResponse(ctx context.Context, id UUID, body CreateBranchJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateBranchResponse, error)

func (*ClientWithResponses) CreateManagedDatabaseWithBodyWithResponse

func (c *ClientWithResponses) CreateManagedDatabaseWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateManagedDatabaseResponse, error)

CreateManagedDatabaseWithBodyWithResponse request with arbitrary body returning *CreateManagedDatabaseResponse

func (*ClientWithResponses) CreateManagedDatabaseWithResponse

func (c *ClientWithResponses) CreateManagedDatabaseWithResponse(ctx context.Context, body CreateManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateManagedDatabaseResponse, error)

func (*ClientWithResponses) DeleteBranchWithResponse

func (c *ClientWithResponses) DeleteBranchWithResponse(ctx context.Context, id UUID, branchId UUID, reqEditors ...RequestEditorFn) (*DeleteBranchResponse, error)

DeleteBranchWithResponse request returning *DeleteBranchResponse

func (*ClientWithResponses) DeleteManagedDatabaseWithResponse

func (c *ClientWithResponses) DeleteManagedDatabaseWithResponse(ctx context.Context, id UUID, params *DeleteManagedDatabaseParams, reqEditors ...RequestEditorFn) (*DeleteManagedDatabaseResponse, error)

DeleteManagedDatabaseWithResponse request returning *DeleteManagedDatabaseResponse

func (*ClientWithResponses) GetBackupWithResponse

func (c *ClientWithResponses) GetBackupWithResponse(ctx context.Context, id UUID, reqEditors ...RequestEditorFn) (*GetBackupResponse, error)

GetBackupWithResponse request returning *GetBackupResponse

func (*ClientWithResponses) GetBranchLogsWithResponse

func (c *ClientWithResponses) GetBranchLogsWithResponse(ctx context.Context, id UUID, branchId UUID, params *GetBranchLogsParams, reqEditors ...RequestEditorFn) (*GetBranchLogsResponse, error)

GetBranchLogsWithResponse request returning *GetBranchLogsResponse

func (*ClientWithResponses) GetBranchMetricsWithResponse

func (c *ClientWithResponses) GetBranchMetricsWithResponse(ctx context.Context, id UUID, branchId UUID, params *GetBranchMetricsParams, reqEditors ...RequestEditorFn) (*GetBranchMetricsResponse, error)

GetBranchMetricsWithResponse request returning *GetBranchMetricsResponse

func (*ClientWithResponses) GetBranchWithResponse

func (c *ClientWithResponses) GetBranchWithResponse(ctx context.Context, id UUID, branchId UUID, params *GetBranchParams, reqEditors ...RequestEditorFn) (*GetBranchResponse, error)

GetBranchWithResponse request returning *GetBranchResponse

func (*ClientWithResponses) GetManagedClientIPWithResponse

func (c *ClientWithResponses) GetManagedClientIPWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetManagedClientIPResponse, error)

GetManagedClientIPWithResponse request returning *GetManagedClientIPResponse

func (*ClientWithResponses) GetManagedDatabaseLogsWithResponse

func (c *ClientWithResponses) GetManagedDatabaseLogsWithResponse(ctx context.Context, id UUID, params *GetManagedDatabaseLogsParams, reqEditors ...RequestEditorFn) (*GetManagedDatabaseLogsResponse, error)

GetManagedDatabaseLogsWithResponse request returning *GetManagedDatabaseLogsResponse

func (*ClientWithResponses) GetManagedDatabaseMetricsWithResponse

func (c *ClientWithResponses) GetManagedDatabaseMetricsWithResponse(ctx context.Context, id UUID, params *GetManagedDatabaseMetricsParams, reqEditors ...RequestEditorFn) (*GetManagedDatabaseMetricsResponse, error)

GetManagedDatabaseMetricsWithResponse request returning *GetManagedDatabaseMetricsResponse

func (*ClientWithResponses) GetManagedDatabaseWithResponse

func (c *ClientWithResponses) GetManagedDatabaseWithResponse(ctx context.Context, id UUID, params *GetManagedDatabaseParams, reqEditors ...RequestEditorFn) (*GetManagedDatabaseResponse, error)

GetManagedDatabaseWithResponse request returning *GetManagedDatabaseResponse

func (*ClientWithResponses) GetManagedOpenApiSpecWithResponse

func (c *ClientWithResponses) GetManagedOpenApiSpecWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetManagedOpenApiSpecResponse, error)

GetManagedOpenApiSpecWithResponse request returning *GetManagedOpenApiSpecResponse

func (*ClientWithResponses) GetManagedPublicOpenApiSpecWithResponse

func (c *ClientWithResponses) GetManagedPublicOpenApiSpecWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetManagedPublicOpenApiSpecResponse, error)

GetManagedPublicOpenApiSpecWithResponse request returning *GetManagedPublicOpenApiSpecResponse

func (*ClientWithResponses) GetSizeWithResponse

func (c *ClientWithResponses) GetSizeWithResponse(ctx context.Context, id UUID, reqEditors ...RequestEditorFn) (*GetSizeResponse, error)

GetSizeWithResponse request returning *GetSizeResponse

func (*ClientWithResponses) ListBackupsWithResponse

func (c *ClientWithResponses) ListBackupsWithResponse(ctx context.Context, params *ListBackupsParams, reqEditors ...RequestEditorFn) (*ListBackupsResponse, error)

ListBackupsWithResponse request returning *ListBackupsResponse

func (*ClientWithResponses) ListBranchesWithResponse

func (c *ClientWithResponses) ListBranchesWithResponse(ctx context.Context, id UUID, params *ListBranchesParams, reqEditors ...RequestEditorFn) (*ListBranchesResponse, error)

ListBranchesWithResponse request returning *ListBranchesResponse

func (*ClientWithResponses) ListManagedDatabasesWithResponse

func (c *ClientWithResponses) ListManagedDatabasesWithResponse(ctx context.Context, params *ListManagedDatabasesParams, reqEditors ...RequestEditorFn) (*ListManagedDatabasesResponse, error)

ListManagedDatabasesWithResponse request returning *ListManagedDatabasesResponse

func (*ClientWithResponses) ListManagedPGVersionsWithResponse

func (c *ClientWithResponses) ListManagedPGVersionsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListManagedPGVersionsResponse, error)

ListManagedPGVersionsWithResponse request returning *ListManagedPGVersionsResponse

func (*ClientWithResponses) ListManagedRegionsWithResponse

func (c *ClientWithResponses) ListManagedRegionsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListManagedRegionsResponse, error)

ListManagedRegionsWithResponse request returning *ListManagedRegionsResponse

func (*ClientWithResponses) ListManagedTasksWithResponse

func (c *ClientWithResponses) ListManagedTasksWithResponse(ctx context.Context, params *ListManagedTasksParams, reqEditors ...RequestEditorFn) (*ListManagedTasksResponse, error)

ListManagedTasksWithResponse request returning *ListManagedTasksResponse

func (*ClientWithResponses) ListSizesWithResponse

func (c *ClientWithResponses) ListSizesWithResponse(ctx context.Context, params *ListSizesParams, reqEditors ...RequestEditorFn) (*ListSizesResponse, error)

ListSizesWithResponse request returning *ListSizesResponse

func (*ClientWithResponses) ResizeManagedDatabaseWithBodyWithResponse

func (c *ClientWithResponses) ResizeManagedDatabaseWithBodyWithResponse(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResizeManagedDatabaseResponse, error)

ResizeManagedDatabaseWithBodyWithResponse request with arbitrary body returning *ResizeManagedDatabaseResponse

func (*ClientWithResponses) ResizeManagedDatabaseWithResponse

func (c *ClientWithResponses) ResizeManagedDatabaseWithResponse(ctx context.Context, id UUID, body ResizeManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*ResizeManagedDatabaseResponse, error)

func (*ClientWithResponses) RestoreManagedDatabaseWithBodyWithResponse

func (c *ClientWithResponses) RestoreManagedDatabaseWithBodyWithResponse(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RestoreManagedDatabaseResponse, error)

RestoreManagedDatabaseWithBodyWithResponse request with arbitrary body returning *RestoreManagedDatabaseResponse

func (*ClientWithResponses) RestoreManagedDatabaseWithResponse

func (c *ClientWithResponses) RestoreManagedDatabaseWithResponse(ctx context.Context, id UUID, body RestoreManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*RestoreManagedDatabaseResponse, error)

func (*ClientWithResponses) RotateManagedDatabaseRolePasswordWithResponse

func (c *ClientWithResponses) RotateManagedDatabaseRolePasswordWithResponse(ctx context.Context, id UUID, roleName RotateManagedDatabaseRolePasswordParamsRoleName, reqEditors ...RequestEditorFn) (*RotateManagedDatabaseRolePasswordResponse, error)

RotateManagedDatabaseRolePasswordWithResponse request returning *RotateManagedDatabaseRolePasswordResponse

func (*ClientWithResponses) UpdateManagedDatabaseWithBodyWithResponse

func (c *ClientWithResponses) UpdateManagedDatabaseWithBodyWithResponse(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateManagedDatabaseResponse, error)

UpdateManagedDatabaseWithBodyWithResponse request with arbitrary body returning *UpdateManagedDatabaseResponse

func (*ClientWithResponses) UpdateManagedDatabaseWithResponse

func (c *ClientWithResponses) UpdateManagedDatabaseWithResponse(ctx context.Context, id UUID, body UpdateManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateManagedDatabaseResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// ListBackupsWithResponse request
	ListBackupsWithResponse(ctx context.Context, params *ListBackupsParams, reqEditors ...RequestEditorFn) (*ListBackupsResponse, error)

	// GetBackupWithResponse request
	GetBackupWithResponse(ctx context.Context, id UUID, reqEditors ...RequestEditorFn) (*GetBackupResponse, error)

	// GetManagedClientIPWithResponse request
	GetManagedClientIPWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetManagedClientIPResponse, error)

	// ListManagedDatabasesWithResponse request
	ListManagedDatabasesWithResponse(ctx context.Context, params *ListManagedDatabasesParams, reqEditors ...RequestEditorFn) (*ListManagedDatabasesResponse, error)

	// CreateManagedDatabaseWithBodyWithResponse request with any body
	CreateManagedDatabaseWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateManagedDatabaseResponse, error)

	CreateManagedDatabaseWithResponse(ctx context.Context, body CreateManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateManagedDatabaseResponse, error)

	// DeleteManagedDatabaseWithResponse request
	DeleteManagedDatabaseWithResponse(ctx context.Context, id UUID, params *DeleteManagedDatabaseParams, reqEditors ...RequestEditorFn) (*DeleteManagedDatabaseResponse, error)

	// GetManagedDatabaseWithResponse request
	GetManagedDatabaseWithResponse(ctx context.Context, id UUID, params *GetManagedDatabaseParams, reqEditors ...RequestEditorFn) (*GetManagedDatabaseResponse, error)

	// UpdateManagedDatabaseWithBodyWithResponse request with any body
	UpdateManagedDatabaseWithBodyWithResponse(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateManagedDatabaseResponse, error)

	UpdateManagedDatabaseWithResponse(ctx context.Context, id UUID, body UpdateManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateManagedDatabaseResponse, error)

	// CreateBackupWithBodyWithResponse request with any body
	CreateBackupWithBodyWithResponse(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateBackupResponse, error)

	CreateBackupWithResponse(ctx context.Context, id UUID, body CreateBackupJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateBackupResponse, error)

	// ListBranchesWithResponse request
	ListBranchesWithResponse(ctx context.Context, id UUID, params *ListBranchesParams, reqEditors ...RequestEditorFn) (*ListBranchesResponse, error)

	// CreateBranchWithBodyWithResponse request with any body
	CreateBranchWithBodyWithResponse(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateBranchResponse, error)

	CreateBranchWithResponse(ctx context.Context, id UUID, body CreateBranchJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateBranchResponse, error)

	// DeleteBranchWithResponse request
	DeleteBranchWithResponse(ctx context.Context, id UUID, branchId UUID, reqEditors ...RequestEditorFn) (*DeleteBranchResponse, error)

	// GetBranchWithResponse request
	GetBranchWithResponse(ctx context.Context, id UUID, branchId UUID, params *GetBranchParams, reqEditors ...RequestEditorFn) (*GetBranchResponse, error)

	// GetBranchLogsWithResponse request
	GetBranchLogsWithResponse(ctx context.Context, id UUID, branchId UUID, params *GetBranchLogsParams, reqEditors ...RequestEditorFn) (*GetBranchLogsResponse, error)

	// GetBranchMetricsWithResponse request
	GetBranchMetricsWithResponse(ctx context.Context, id UUID, branchId UUID, params *GetBranchMetricsParams, reqEditors ...RequestEditorFn) (*GetBranchMetricsResponse, error)

	// GetManagedDatabaseLogsWithResponse request
	GetManagedDatabaseLogsWithResponse(ctx context.Context, id UUID, params *GetManagedDatabaseLogsParams, reqEditors ...RequestEditorFn) (*GetManagedDatabaseLogsResponse, error)

	// GetManagedDatabaseMetricsWithResponse request
	GetManagedDatabaseMetricsWithResponse(ctx context.Context, id UUID, params *GetManagedDatabaseMetricsParams, reqEditors ...RequestEditorFn) (*GetManagedDatabaseMetricsResponse, error)

	// RestoreManagedDatabaseWithBodyWithResponse request with any body
	RestoreManagedDatabaseWithBodyWithResponse(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RestoreManagedDatabaseResponse, error)

	RestoreManagedDatabaseWithResponse(ctx context.Context, id UUID, body RestoreManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*RestoreManagedDatabaseResponse, error)

	// RotateManagedDatabaseRolePasswordWithResponse request
	RotateManagedDatabaseRolePasswordWithResponse(ctx context.Context, id UUID, roleName RotateManagedDatabaseRolePasswordParamsRoleName, reqEditors ...RequestEditorFn) (*RotateManagedDatabaseRolePasswordResponse, error)

	// ResizeManagedDatabaseWithBodyWithResponse request with any body
	ResizeManagedDatabaseWithBodyWithResponse(ctx context.Context, id UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResizeManagedDatabaseResponse, error)

	ResizeManagedDatabaseWithResponse(ctx context.Context, id UUID, body ResizeManagedDatabaseJSONRequestBody, reqEditors ...RequestEditorFn) (*ResizeManagedDatabaseResponse, error)

	// GetManagedOpenApiSpecWithResponse request
	GetManagedOpenApiSpecWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetManagedOpenApiSpecResponse, error)

	// GetManagedPublicOpenApiSpecWithResponse request
	GetManagedPublicOpenApiSpecWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetManagedPublicOpenApiSpecResponse, error)

	// ListManagedPGVersionsWithResponse request
	ListManagedPGVersionsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListManagedPGVersionsResponse, error)

	// ListManagedRegionsWithResponse request
	ListManagedRegionsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListManagedRegionsResponse, error)

	// ListSizesWithResponse request
	ListSizesWithResponse(ctx context.Context, params *ListSizesParams, reqEditors ...RequestEditorFn) (*ListSizesResponse, error)

	// GetSizeWithResponse request
	GetSizeWithResponse(ctx context.Context, id UUID, reqEditors ...RequestEditorFn) (*GetSizeResponse, error)

	// ListManagedTasksWithResponse request
	ListManagedTasksWithResponse(ctx context.Context, params *ListManagedTasksParams, reqEditors ...RequestEditorFn) (*ListManagedTasksResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CreateBackupJSONRequestBody

type CreateBackupJSONRequestBody = CreateBackupRequest

CreateBackupJSONRequestBody defines body for CreateBackup for application/json ContentType.

type CreateBackupRequest

type CreateBackupRequest struct {
	// Kind Backup tier to take: "hot" (fast local VolumeSnapshot) or "durable" (base backup streamed to object storage; requires the durable tier to be enabled for the database).
	Kind string `json:"kind"`
}

CreateBackupRequest defines model for CreateBackupRequest.

type CreateBackupResponse

type CreateBackupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *Backup
	JSON400      *Error
	JSON401      *Error
	JSON404      *Error
	JSONDefault  *Error
}

func ParseCreateBackupResponse

func ParseCreateBackupResponse(rsp *http.Response) (*CreateBackupResponse, error)

ParseCreateBackupResponse parses an HTTP response from a CreateBackupWithResponse call

func (CreateBackupResponse) ContentType

func (r CreateBackupResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateBackupResponse) Status

func (r CreateBackupResponse) Status() string

Status returns HTTPResponse.Status

func (CreateBackupResponse) StatusCode

func (r CreateBackupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateBranchJSONRequestBody

type CreateBranchJSONRequestBody = CreateBranchRequest

CreateBranchJSONRequestBody defines body for CreateBranch for application/json ContentType.

type CreateBranchRequest

type CreateBranchRequest struct {
	// DisplayName Optional display name for the branch.
	DisplayName *string `json:"display_name,omitempty"`

	// IpAllowlist Source addresses permitted to reach the branch's POSTGRES endpoint. Omitted, the branch copies the source database's current rules, so its Postgres endpoint is reachable from wherever its source's is. Explicit rules replace the copy; explicit empty rules close the Postgres endpoint (the branch's AI services still reach it in-cluster). This field governs Postgres only: each AI service's own HTTP endpoint keeps the allowlist copied with its service config from the source, reported per service in the response. Every branch allowlist is fixed at creation — changes to the source never reach the branch, and to change one, recreate the branch.
	IpAllowlist *IPAllowlist `json:"ip_allowlist,omitempty"`

	// SourceBranchId Reserved for branching a branch; refused until that ships.
	SourceBranchId *string `json:"source_branch_id,omitempty"`
}

CreateBranchRequest defines model for CreateBranchRequest.

type CreateBranchResponse

type CreateBranchResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *Branch
	JSON400      *Error
	JSON401      *Error
	JSON404      *Error
	JSON409      *Error
	JSONDefault  *Error
}

func ParseCreateBranchResponse

func ParseCreateBranchResponse(rsp *http.Response) (*CreateBranchResponse, error)

ParseCreateBranchResponse parses an HTTP response from a CreateBranchWithResponse call

func (CreateBranchResponse) ContentType

func (r CreateBranchResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateBranchResponse) Status

func (r CreateBranchResponse) Status() string

Status returns HTTPResponse.Status

func (CreateBranchResponse) StatusCode

func (r CreateBranchResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateManagedDatabaseInput

type CreateManagedDatabaseInput struct {
	// DisplayName Display name for the database.
	DisplayName nullable.Nullable[string] `json:"display_name,omitempty"`

	// IpAllowlist Source addresses permitted to reach the Postgres endpoint. Omitted, the database is created closed and reaches nobody until a rule is added. Each service's allowlist rides its entry in services, with the same closed default.
	IpAllowlist *IPAllowlist `json:"ip_allowlist,omitempty"`
	Name        string       `json:"name"`
	Options     *[]string    `json:"options,omitempty"`

	// PgVersion PostgreSQL major version. Fixed for the life of the database; defaults to the newest supported version when omitted.
	PgVersion *CreateManagedDatabaseInputPgVersion `json:"pg_version,omitempty"`

	// Region Region in which to place the managed database.
	Region string `json:"region"`

	// Services AI services to provision on the database.
	Services *[]ServiceConfig `json:"services,omitempty"`

	// Size Size for the managed database (e.g. "small", "large",
	// "xl"). Validated server-side against the active
	// managed-size catalog.
	Size string `json:"size"`
}

CreateManagedDatabaseInput defines model for CreateManagedDatabaseInput.

type CreateManagedDatabaseInputPgVersion

type CreateManagedDatabaseInputPgVersion string

CreateManagedDatabaseInputPgVersion PostgreSQL major version. Fixed for the life of the database; defaults to the newest supported version when omitted.

Defines values for CreateManagedDatabaseInputPgVersion.

func (CreateManagedDatabaseInputPgVersion) Valid

Valid indicates whether the value is a known member of the CreateManagedDatabaseInputPgVersion enum.

type CreateManagedDatabaseJSONRequestBody

type CreateManagedDatabaseJSONRequestBody = CreateManagedDatabaseInput

CreateManagedDatabaseJSONRequestBody defines body for CreateManagedDatabase for application/json ContentType.

type CreateManagedDatabaseResponse

type CreateManagedDatabaseResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ManagedDatabase
	JSON400      *Error
	JSON401      *Error
	JSONDefault  *Error
}

func ParseCreateManagedDatabaseResponse

func ParseCreateManagedDatabaseResponse(rsp *http.Response) (*CreateManagedDatabaseResponse, error)

ParseCreateManagedDatabaseResponse parses an HTTP response from a CreateManagedDatabaseWithResponse call

func (CreateManagedDatabaseResponse) ContentType

func (r CreateManagedDatabaseResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateManagedDatabaseResponse) Status

Status returns HTTPResponse.Status

func (CreateManagedDatabaseResponse) StatusCode

func (r CreateManagedDatabaseResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateRestoreRequest

type CreateRestoreRequest struct {
	// BackupId ID of the backup to restore from. Must be a completed backup of this database.
	BackupId string `json:"backup_id"`
}

CreateRestoreRequest defines model for CreateRestoreRequest.

type DatabaseLogsResponse

type DatabaseLogsResponse struct {
	Logs []map[string]interface{} `json:"logs"`
}

DatabaseLogsResponse defines model for DatabaseLogsResponse.

type DeleteBranchResponse

type DeleteBranchResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *Error
	JSON401      *Error
	JSON404      *Error
	JSON409      *Error
	JSONDefault  *Error
}

func ParseDeleteBranchResponse

func ParseDeleteBranchResponse(rsp *http.Response) (*DeleteBranchResponse, error)

ParseDeleteBranchResponse parses an HTTP response from a DeleteBranchWithResponse call

func (DeleteBranchResponse) ContentType

func (r DeleteBranchResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteBranchResponse) Status

func (r DeleteBranchResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteBranchResponse) StatusCode

func (r DeleteBranchResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteManagedDatabaseParams

type DeleteManagedDatabaseParams struct {
	// Force Also delete every branch of the database, ahead of the database itself. Branch data cannot be recovered.
	Force *bool `form:"force,omitempty" json:"force,omitempty"`
}

DeleteManagedDatabaseParams defines parameters for DeleteManagedDatabase.

type DeleteManagedDatabaseResponse

type DeleteManagedDatabaseResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *Error
	JSON401      *Error
	JSON409      *Error
	JSONDefault  *Error
}

func ParseDeleteManagedDatabaseResponse

func ParseDeleteManagedDatabaseResponse(rsp *http.Response) (*DeleteManagedDatabaseResponse, error)

ParseDeleteManagedDatabaseResponse parses an HTTP response from a DeleteManagedDatabaseWithResponse call

func (DeleteManagedDatabaseResponse) ContentType

func (r DeleteManagedDatabaseResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteManagedDatabaseResponse) Status

Status returns HTTPResponse.Status

func (DeleteManagedDatabaseResponse) StatusCode

func (r DeleteManagedDatabaseResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Error

type Error struct {
	Code    int    `json:"code"`
	Message string `json:"message"`

	// Reason Stable, machine-readable discriminator for programmatic client handling. Absent for generic errors. Clients must treat an unrecognized value as a generic error of the given status code.
	Reason *ErrorReason `json:"reason,omitempty"`
}

Error defines model for Error.

type ErrorReason

type ErrorReason string

ErrorReason Stable, machine-readable discriminator for programmatic client handling. Absent for generic errors. Clients must treat an unrecognized value as a generic error of the given status code.

const (
	DeveloperPlanBackup ErrorReason = "developer_plan_backup"
	MembershipRevoked   ErrorReason = "membership_revoked"
	PlanExpired         ErrorReason = "plan_expired"
)

Defines values for ErrorReason.

func (ErrorReason) Valid

func (e ErrorReason) Valid() bool

Valid indicates whether the value is a known member of the ErrorReason enum.

type GetBackupResponse

type GetBackupResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Backup
	JSON400      *Error
	JSON401      *Error
	JSON404      *Error
	JSONDefault  *Error
}

func ParseGetBackupResponse

func ParseGetBackupResponse(rsp *http.Response) (*GetBackupResponse, error)

ParseGetBackupResponse parses an HTTP response from a GetBackupWithResponse call

func (GetBackupResponse) ContentType

func (r GetBackupResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetBackupResponse) Status

func (r GetBackupResponse) Status() string

Status returns HTTPResponse.Status

func (GetBackupResponse) StatusCode

func (r GetBackupResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBranchLogsParams

type GetBranchLogsParams struct {
	// MaxLines Maximum number of log lines to retrieve.
	MaxLines *int `form:"max_lines,omitempty" json:"max_lines,omitempty"`

	// StartTime Start of an absolute time window as an RFC3339 timestamp. When omitted, the window is open at the start and the most recent lines are returned.
	StartTime *time.Time `form:"start_time,omitempty" json:"start_time,omitempty"`

	// EndTime End of an absolute time window as an RFC3339 timestamp. When omitted, the window is open at the end.
	EndTime *time.Time `form:"end_time,omitempty" json:"end_time,omitempty"`
}

GetBranchLogsParams defines parameters for GetBranchLogs.

type GetBranchLogsResponse

type GetBranchLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DatabaseLogsResponse
	JSON400      *Error
	JSON401      *Error
	JSON404      *Error
	JSONDefault  *Error
}

func ParseGetBranchLogsResponse

func ParseGetBranchLogsResponse(rsp *http.Response) (*GetBranchLogsResponse, error)

ParseGetBranchLogsResponse parses an HTTP response from a GetBranchLogsWithResponse call

func (GetBranchLogsResponse) ContentType

func (r GetBranchLogsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetBranchLogsResponse) Status

func (r GetBranchLogsResponse) Status() string

Status returns HTTPResponse.Status

func (GetBranchLogsResponse) StatusCode

func (r GetBranchLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBranchMetricsParams

type GetBranchMetricsParams struct {
	// Interval Relative lookback window for the metrics, specified in value, unit format (e.g. "15,minutes"). It determines the window only when neither start_time nor end_time is supplied, but is validated in all cases.
	Interval *string `form:"interval,omitempty" json:"interval,omitempty"`

	// StartTime Start of an absolute time window as an RFC3339 timestamp. When omitted while end_time is supplied, the window is open at the start rather than falling back to interval.
	StartTime *time.Time `form:"start_time,omitempty" json:"start_time,omitempty"`

	// EndTime End of an absolute time window as an RFC3339 timestamp. When omitted, the window is open at the end.
	EndTime *time.Time `form:"end_time,omitempty" json:"end_time,omitempty"`
}

GetBranchMetricsParams defines parameters for GetBranchMetrics.

type GetBranchMetricsResponse

type GetBranchMetricsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *MetricSeriesContainer
	JSON400      *Error
	JSON401      *Error
	JSON404      *Error
	JSONDefault  *Error
}

func ParseGetBranchMetricsResponse

func ParseGetBranchMetricsResponse(rsp *http.Response) (*GetBranchMetricsResponse, error)

ParseGetBranchMetricsResponse parses an HTTP response from a GetBranchMetricsWithResponse call

func (GetBranchMetricsResponse) ContentType

func (r GetBranchMetricsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetBranchMetricsResponse) Status

func (r GetBranchMetricsResponse) Status() string

Status returns HTTPResponse.Status

func (GetBranchMetricsResponse) StatusCode

func (r GetBranchMetricsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBranchParams

type GetBranchParams struct {
	// UserType The user type whose credentials will be returned. Defaults to the application user. "application_read_only" is the read-only role the branch's AI services connect as.
	UserType *GetBranchParamsUserType `form:"user_type,omitempty" json:"user_type,omitempty"`
}

GetBranchParams defines parameters for GetBranch.

type GetBranchParamsUserType

type GetBranchParamsUserType string

GetBranchParamsUserType defines parameters for GetBranch.

const (
	GetBranchParamsUserTypeAdmin               GetBranchParamsUserType = "admin"
	GetBranchParamsUserTypeApplication         GetBranchParamsUserType = "application"
	GetBranchParamsUserTypeApplicationReadOnly GetBranchParamsUserType = "application_read_only"
)

Defines values for GetBranchParamsUserType.

func (GetBranchParamsUserType) Valid

func (e GetBranchParamsUserType) Valid() bool

Valid indicates whether the value is a known member of the GetBranchParamsUserType enum.

type GetBranchResponse

type GetBranchResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Branch
	JSON400      *Error
	JSON401      *Error
	JSON404      *Error
	JSONDefault  *Error
}

func ParseGetBranchResponse

func ParseGetBranchResponse(rsp *http.Response) (*GetBranchResponse, error)

ParseGetBranchResponse parses an HTTP response from a GetBranchWithResponse call

func (GetBranchResponse) ContentType

func (r GetBranchResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetBranchResponse) Status

func (r GetBranchResponse) Status() string

Status returns HTTPResponse.Status

func (GetBranchResponse) StatusCode

func (r GetBranchResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetManagedClientIPResponse

type GetManagedClientIPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ClientIPAddress
	JSON401      *Error
	JSONDefault  *Error
}

func ParseGetManagedClientIPResponse

func ParseGetManagedClientIPResponse(rsp *http.Response) (*GetManagedClientIPResponse, error)

ParseGetManagedClientIPResponse parses an HTTP response from a GetManagedClientIPWithResponse call

func (GetManagedClientIPResponse) ContentType

func (r GetManagedClientIPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetManagedClientIPResponse) Status

Status returns HTTPResponse.Status

func (GetManagedClientIPResponse) StatusCode

func (r GetManagedClientIPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetManagedDatabaseLogsParams

type GetManagedDatabaseLogsParams struct {
	// MaxLines Maximum number of log lines to retrieve.
	MaxLines *int `form:"max_lines,omitempty" json:"max_lines,omitempty"`

	// StartTime Start of an absolute time window as an RFC3339 timestamp. When omitted, the window is open at the start and the most recent lines are returned.
	StartTime *time.Time `form:"start_time,omitempty" json:"start_time,omitempty"`

	// EndTime End of an absolute time window as an RFC3339 timestamp. When omitted, the window is open at the end.
	EndTime *time.Time `form:"end_time,omitempty" json:"end_time,omitempty"`
}

GetManagedDatabaseLogsParams defines parameters for GetManagedDatabaseLogs.

type GetManagedDatabaseLogsResponse

type GetManagedDatabaseLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DatabaseLogsResponse
	JSON400      *Error
	JSON401      *Error
	JSON404      *Error
	JSONDefault  *Error
}

func ParseGetManagedDatabaseLogsResponse

func ParseGetManagedDatabaseLogsResponse(rsp *http.Response) (*GetManagedDatabaseLogsResponse, error)

ParseGetManagedDatabaseLogsResponse parses an HTTP response from a GetManagedDatabaseLogsWithResponse call

func (GetManagedDatabaseLogsResponse) ContentType

func (r GetManagedDatabaseLogsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetManagedDatabaseLogsResponse) Status

Status returns HTTPResponse.Status

func (GetManagedDatabaseLogsResponse) StatusCode

func (r GetManagedDatabaseLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetManagedDatabaseMetricsParams

type GetManagedDatabaseMetricsParams struct {
	// Interval Relative lookback window for the metrics, specified in value, unit format (e.g. "15,minutes"). It determines the window only when neither start_time nor end_time is supplied, but is validated in all cases.
	Interval *string `form:"interval,omitempty" json:"interval,omitempty"`

	// StartTime Start of an absolute time window as an RFC3339 timestamp. When omitted while end_time is supplied, the window is open at the start rather than falling back to interval.
	StartTime *time.Time `form:"start_time,omitempty" json:"start_time,omitempty"`

	// EndTime End of an absolute time window as an RFC3339 timestamp. When omitted, the window is open at the end.
	EndTime *time.Time `form:"end_time,omitempty" json:"end_time,omitempty"`
}

GetManagedDatabaseMetricsParams defines parameters for GetManagedDatabaseMetrics.

type GetManagedDatabaseMetricsResponse

type GetManagedDatabaseMetricsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *MetricSeriesContainer
	JSON400      *Error
	JSON401      *Error
	JSON404      *Error
	JSONDefault  *Error
}

func ParseGetManagedDatabaseMetricsResponse

func ParseGetManagedDatabaseMetricsResponse(rsp *http.Response) (*GetManagedDatabaseMetricsResponse, error)

ParseGetManagedDatabaseMetricsResponse parses an HTTP response from a GetManagedDatabaseMetricsWithResponse call

func (GetManagedDatabaseMetricsResponse) ContentType

func (r GetManagedDatabaseMetricsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetManagedDatabaseMetricsResponse) Status

Status returns HTTPResponse.Status

func (GetManagedDatabaseMetricsResponse) StatusCode

func (r GetManagedDatabaseMetricsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetManagedDatabaseParams

type GetManagedDatabaseParams struct {
	// UserType The user type whose credentials will be returned: "application", "admin", or "application_read_only". Defaults to the application user, the role an application connects as for day-to-day work. "application_read_only" is the read-only role the AI services connect as; a database created before it existed does not have one. While the database is "modifying" because of a password rotation, the credential returned here is the new one and does not authenticate yet; the previous one still does until the database returns to "available".
	UserType *GetManagedDatabaseParamsUserType `form:"user_type,omitempty" json:"user_type,omitempty"`
}

GetManagedDatabaseParams defines parameters for GetManagedDatabase.

type GetManagedDatabaseParamsUserType

type GetManagedDatabaseParamsUserType string

GetManagedDatabaseParamsUserType defines parameters for GetManagedDatabase.

const (
	GetManagedDatabaseParamsUserTypeAdmin               GetManagedDatabaseParamsUserType = "admin"
	GetManagedDatabaseParamsUserTypeApplication         GetManagedDatabaseParamsUserType = "application"
	GetManagedDatabaseParamsUserTypeApplicationReadOnly GetManagedDatabaseParamsUserType = "application_read_only"
)

Defines values for GetManagedDatabaseParamsUserType.

func (GetManagedDatabaseParamsUserType) Valid

Valid indicates whether the value is a known member of the GetManagedDatabaseParamsUserType enum.

type GetManagedDatabaseResponse

type GetManagedDatabaseResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ManagedDatabase
	JSON400      *Error
	JSON401      *Error
	JSONDefault  *Error
}

func ParseGetManagedDatabaseResponse

func ParseGetManagedDatabaseResponse(rsp *http.Response) (*GetManagedDatabaseResponse, error)

ParseGetManagedDatabaseResponse parses an HTTP response from a GetManagedDatabaseWithResponse call

func (GetManagedDatabaseResponse) ContentType

func (r GetManagedDatabaseResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetManagedDatabaseResponse) Status

Status returns HTTPResponse.Status

func (GetManagedDatabaseResponse) StatusCode

func (r GetManagedDatabaseResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetManagedOpenApiSpecResponse

type GetManagedOpenApiSpecResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OpenApiSpec
	JSONDefault  *Error
}

func ParseGetManagedOpenApiSpecResponse

func ParseGetManagedOpenApiSpecResponse(rsp *http.Response) (*GetManagedOpenApiSpecResponse, error)

ParseGetManagedOpenApiSpecResponse parses an HTTP response from a GetManagedOpenApiSpecWithResponse call

func (GetManagedOpenApiSpecResponse) ContentType

func (r GetManagedOpenApiSpecResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetManagedOpenApiSpecResponse) Status

Status returns HTTPResponse.Status

func (GetManagedOpenApiSpecResponse) StatusCode

func (r GetManagedOpenApiSpecResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetManagedPublicOpenApiSpecResponse

type GetManagedPublicOpenApiSpecResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OpenApiSpec
	JSONDefault  *Error
}

func ParseGetManagedPublicOpenApiSpecResponse

func ParseGetManagedPublicOpenApiSpecResponse(rsp *http.Response) (*GetManagedPublicOpenApiSpecResponse, error)

ParseGetManagedPublicOpenApiSpecResponse parses an HTTP response from a GetManagedPublicOpenApiSpecWithResponse call

func (GetManagedPublicOpenApiSpecResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetManagedPublicOpenApiSpecResponse) Status

Status returns HTTPResponse.Status

func (GetManagedPublicOpenApiSpecResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetSizeResponse

type GetSizeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Size
	JSON400      *Error
	JSON401      *Error
	JSON404      *Error
	JSONDefault  *Error
}

func ParseGetSizeResponse

func ParseGetSizeResponse(rsp *http.Response) (*GetSizeResponse, error)

ParseGetSizeResponse parses an HTTP response from a GetSizeWithResponse call

func (GetSizeResponse) ContentType

func (r GetSizeResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetSizeResponse) Status

func (r GetSizeResponse) Status() string

Status returns HTTPResponse.Status

func (GetSizeResponse) StatusCode

func (r GetSizeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type IPAllowlist

type IPAllowlist struct {
	Rules []IPAllowlistRule `json:"rules"`

	// State The posture the rules express: "closed" when there are none and no source address reaches the endpoint, "open" when a rule admits every address, "restricted" otherwise. Derived from the rules; ignored on input.
	State *IPAllowlistState `json:"state,omitempty"`
}

IPAllowlist One endpoint's source-address allowlist. Every endpoint keeps its own: a rule on one has no effect on any other, and none of them inherit.

type IPAllowlistRule

type IPAllowlistRule struct {
	// Cidr An IPv4 address or CIDR block, e.g. "203.0.113.7" or "203.0.113.0/24". A bare address is stored as a /32, and a block is stored masked to its network address. IPv6 is rejected: the ingress these rules are enforced at is reachable over IPv4 only.
	Cidr string `json:"cidr"`

	// Label Optional note describing what the entry is for.
	Label *string `json:"label,omitempty"`
}

IPAllowlistRule defines model for IPAllowlistRule.

type IPAllowlistState

type IPAllowlistState string

IPAllowlistState The posture the rules express: "closed" when there are none and no source address reaches the endpoint, "open" when a rule admits every address, "restricted" otherwise. Derived from the rules; ignored on input.

const (
	Closed     IPAllowlistState = "closed"
	Open       IPAllowlistState = "open"
	Restricted IPAllowlistState = "restricted"
)

Defines values for IPAllowlistState.

func (IPAllowlistState) Valid

func (e IPAllowlistState) Valid() bool

Valid indicates whether the value is a known member of the IPAllowlistState enum.

type ListBackupsParams

type ListBackupsParams struct {
	// DatabaseId Filter backups to a specific database ID.
	DatabaseId *UUID `form:"database_id,omitempty" json:"database_id,omitempty"`

	// Kind Filter backups to a specific kind: "hot" (VolumeSnapshot) or "durable" (object store).
	Kind *ListBackupsParamsKind `form:"kind,omitempty" json:"kind,omitempty"`

	// CreatedAfter Start time for backup retrieval as an RFC3339 timestamp.
	CreatedAfter *time.Time `form:"created_after,omitempty" json:"created_after,omitempty"`

	// CreatedBefore End time for backup retrieval as an RFC3339 timestamp.
	CreatedBefore *time.Time `form:"created_before,omitempty" json:"created_before,omitempty"`

	// Limit Maximum number of results to return.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Offset into the results for pagination.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// Descending Sort by creation time in descending order. Defaults to true, so the newest restore points come first.
	Descending *bool `form:"descending,omitempty" json:"descending,omitempty"`
}

ListBackupsParams defines parameters for ListBackups.

type ListBackupsParamsKind

type ListBackupsParamsKind string

ListBackupsParamsKind defines parameters for ListBackups.

const (
	Durable ListBackupsParamsKind = "durable"
	Hot     ListBackupsParamsKind = "hot"
)

Defines values for ListBackupsParamsKind.

func (ListBackupsParamsKind) Valid

func (e ListBackupsParamsKind) Valid() bool

Valid indicates whether the value is a known member of the ListBackupsParamsKind enum.

type ListBackupsResponse

type ListBackupsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Backup
	JSON400      *Error
	JSON401      *Error
	JSONDefault  *Error
}

func ParseListBackupsResponse

func ParseListBackupsResponse(rsp *http.Response) (*ListBackupsResponse, error)

ParseListBackupsResponse parses an HTTP response from a ListBackupsWithResponse call

func (ListBackupsResponse) ContentType

func (r ListBackupsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListBackupsResponse) Status

func (r ListBackupsResponse) Status() string

Status returns HTTPResponse.Status

func (ListBackupsResponse) StatusCode

func (r ListBackupsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListBranchesParams

type ListBranchesParams struct {
	// IncludeDeleted Include deleted branches (the audit view).
	IncludeDeleted *bool `form:"include_deleted,omitempty" json:"include_deleted,omitempty"`

	// Limit Maximum number of results to return.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Offset into the results for pagination.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// Descending Sort by creation time in descending order, newest first.
	Descending *bool `form:"descending,omitempty" json:"descending,omitempty"`
}

ListBranchesParams defines parameters for ListBranches.

type ListBranchesResponse

type ListBranchesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Branch
	JSON400      *Error
	JSON401      *Error
	JSON404      *Error
	JSONDefault  *Error
}

func ParseListBranchesResponse

func ParseListBranchesResponse(rsp *http.Response) (*ListBranchesResponse, error)

ParseListBranchesResponse parses an HTTP response from a ListBranchesWithResponse call

func (ListBranchesResponse) ContentType

func (r ListBranchesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListBranchesResponse) Status

func (r ListBranchesResponse) Status() string

Status returns HTTPResponse.Status

func (ListBranchesResponse) StatusCode

func (r ListBranchesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListManagedDatabasesParams

type ListManagedDatabasesParams struct {
	// Region Filter databases to a specific region.
	Region *string `form:"region,omitempty" json:"region,omitempty"`

	// CreatedAfter Start time for database retrieval as an RFC3339 timestamp.
	CreatedAfter *time.Time `form:"created_after,omitempty" json:"created_after,omitempty"`

	// CreatedBefore End time for database retrieval as an RFC3339 timestamp.
	CreatedBefore *time.Time `form:"created_before,omitempty" json:"created_before,omitempty"`

	// Limit Maximum number of results to return.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Offset into the results for pagination.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// Descending Sort in descending order.
	Descending *bool `form:"descending,omitempty" json:"descending,omitempty"`
}

ListManagedDatabasesParams defines parameters for ListManagedDatabases.

type ListManagedDatabasesResponse

type ListManagedDatabasesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]ManagedDatabase
	JSON400      *Error
	JSON401      *Error
	JSONDefault  *Error
}

func ParseListManagedDatabasesResponse

func ParseListManagedDatabasesResponse(rsp *http.Response) (*ListManagedDatabasesResponse, error)

ParseListManagedDatabasesResponse parses an HTTP response from a ListManagedDatabasesWithResponse call

func (ListManagedDatabasesResponse) ContentType

func (r ListManagedDatabasesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListManagedDatabasesResponse) Status

Status returns HTTPResponse.Status

func (ListManagedDatabasesResponse) StatusCode

func (r ListManagedDatabasesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListManagedPGVersionsResponse

type ListManagedPGVersionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]ManagedPGVersion
	JSON401      *Error
	JSONDefault  *Error
}

func ParseListManagedPGVersionsResponse

func ParseListManagedPGVersionsResponse(rsp *http.Response) (*ListManagedPGVersionsResponse, error)

ParseListManagedPGVersionsResponse parses an HTTP response from a ListManagedPGVersionsWithResponse call

func (ListManagedPGVersionsResponse) ContentType

func (r ListManagedPGVersionsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListManagedPGVersionsResponse) Status

Status returns HTTPResponse.Status

func (ListManagedPGVersionsResponse) StatusCode

func (r ListManagedPGVersionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListManagedRegionsResponse

type ListManagedRegionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]ManagedRegion
	JSON401      *Error
	JSONDefault  *Error
}

func ParseListManagedRegionsResponse

func ParseListManagedRegionsResponse(rsp *http.Response) (*ListManagedRegionsResponse, error)

ParseListManagedRegionsResponse parses an HTTP response from a ListManagedRegionsWithResponse call

func (ListManagedRegionsResponse) ContentType

func (r ListManagedRegionsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListManagedRegionsResponse) Status

Status returns HTTPResponse.Status

func (ListManagedRegionsResponse) StatusCode

func (r ListManagedRegionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListManagedTasksParams

type ListManagedTasksParams struct {
	// SubjectId Filter tasks by subject id.
	SubjectId *string `form:"subject_id,omitempty" json:"subject_id,omitempty"`

	// SubjectKind Filter tasks by kind.
	SubjectKind *string `form:"subject_kind,omitempty" json:"subject_kind,omitempty"`

	// Id Filter tasks by id.
	Id *string `form:"id,omitempty" json:"id,omitempty"`

	// Name Filter tasks by name.
	Name *string `form:"name,omitempty" json:"name,omitempty"`

	// Status Filter tasks by status.
	Status *ListManagedTasksParamsStatus `form:"status,omitempty" json:"status,omitempty"`

	// Limit Maximum number of results to return.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Offset Offset into the results for pagination.
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
}

ListManagedTasksParams defines parameters for ListManagedTasks.

type ListManagedTasksParamsStatus

type ListManagedTasksParamsStatus string

ListManagedTasksParamsStatus defines parameters for ListManagedTasks.

const (
	Failed    ListManagedTasksParamsStatus = "failed"
	Queued    ListManagedTasksParamsStatus = "queued"
	Running   ListManagedTasksParamsStatus = "running"
	Succeeded ListManagedTasksParamsStatus = "succeeded"
)

Defines values for ListManagedTasksParamsStatus.

func (ListManagedTasksParamsStatus) Valid

Valid indicates whether the value is a known member of the ListManagedTasksParamsStatus enum.

type ListManagedTasksResponse

type ListManagedTasksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Task
	JSON400      *Error
	JSON401      *Error
	JSONDefault  *Error
}

func ParseListManagedTasksResponse

func ParseListManagedTasksResponse(rsp *http.Response) (*ListManagedTasksResponse, error)

ParseListManagedTasksResponse parses an HTTP response from a ListManagedTasksWithResponse call

func (ListManagedTasksResponse) ContentType

func (r ListManagedTasksResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListManagedTasksResponse) Status

func (r ListManagedTasksResponse) Status() string

Status returns HTTPResponse.Status

func (ListManagedTasksResponse) StatusCode

func (r ListManagedTasksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSizesParams

type ListSizesParams struct {
	// Include Related data to embed in each size. `pricing` resolves the
	// size's current price from the billing provider; sizes with
	// no configured price omit the field.
	Include *[]ListSizesParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

ListSizesParams defines parameters for ListSizes.

type ListSizesParamsInclude

type ListSizesParamsInclude string

ListSizesParamsInclude defines parameters for ListSizes.

const (
	Pricing ListSizesParamsInclude = "pricing"
)

Defines values for ListSizesParamsInclude.

func (ListSizesParamsInclude) Valid

func (e ListSizesParamsInclude) Valid() bool

Valid indicates whether the value is a known member of the ListSizesParamsInclude enum.

type ListSizesResponse

type ListSizesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Size
	JSON400      *Error
	JSON401      *Error
	JSONDefault  *Error
}

func ParseListSizesResponse

func ParseListSizesResponse(rsp *http.Response) (*ListSizesResponse, error)

ParseListSizesResponse parses an HTTP response from a ListSizesWithResponse call

func (ListSizesResponse) ContentType

func (r ListSizesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListSizesResponse) Status

func (r ListSizesResponse) Status() string

Status returns HTTPResponse.Status

func (ListSizesResponse) StatusCode

func (r ListSizesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MCPServiceConfig

type MCPServiceConfig struct {
	// AllowWrites Grant the MCP service read-write (INSERT/UPDATE/DELETE) access to the database via its query_database tool.
	//
	// WARNING: enabling this allows the LLM to modify, delete, or corrupt data. Only enable on development or test databases where data loss is acceptable.
	//
	// Defaults to false (read-only).
	AllowWrites *bool `json:"allow_writes,omitempty"`

	// EmbeddingApiKey API key for the embedding provider. Required when
	// embedding_provider is set on create; on update the
	// stored key is reused if omitted. Stored encrypted
	// server-side; returned on the single-database and
	// single-branch GETs. A branch inherits the source's
	// key at creation.
	EmbeddingApiKey *string `json:"embedding_api_key,omitempty"`

	// EmbeddingModel Embedding model identifier. Required when embedding_provider is set.
	EmbeddingModel *string `json:"embedding_model,omitempty"`

	// EmbeddingProvider Embedding provider. Setting this enables the generate_embedding tool on the MCP server.
	EmbeddingProvider *MCPServiceConfigEmbeddingProvider `json:"embedding_provider,omitempty"`

	// InitTokens Bearer token forwarded to the MCP server as INIT_TOKENS.
	// Generated server-side when omitted, since the MCP server
	// requires one. Stored encrypted server-side; returned on
	// the single-database and single-branch GETs. A branch
	// never shares its source's token: branch creation mints
	// the branch its own.
	InitTokens *string `json:"init_tokens,omitempty"`

	// InitUsers Optional comma-separated list of username:password pairs
	// forwarded to the MCP server as INIT_USERS. Stored
	// encrypted server-side; returned in
	// GET /managed/v1/databases/{id}. Branches neither inherit
	// nor mint init_users; a branch MCP authenticates by its
	// minted token only.
	InitUsers *string `json:"init_users,omitempty"`
}

MCPServiceConfig MCP service configuration. Only the generate_embedding / embedding block is exposed here. NLA / web chat proxy (llm.*) configuration is not yet exposed through the SaaS API.

type MCPServiceConfigEmbeddingProvider

type MCPServiceConfigEmbeddingProvider string

MCPServiceConfigEmbeddingProvider Embedding provider. Setting this enables the generate_embedding tool on the MCP server.

const (
	MCPServiceConfigEmbeddingProviderOpenai MCPServiceConfigEmbeddingProvider = "openai"
	MCPServiceConfigEmbeddingProviderVoyage MCPServiceConfigEmbeddingProvider = "voyage"
)

Defines values for MCPServiceConfigEmbeddingProvider.

func (MCPServiceConfigEmbeddingProvider) Valid

Valid indicates whether the value is a known member of the MCPServiceConfigEmbeddingProvider enum.

type ManagedConnection

type ManagedConnection struct {
	Database          string  `json:"database"`
	ExternalIpAddress *string `json:"external_ip_address,omitempty"`
	Host              *string `json:"host,omitempty"`
	Password          string  `json:"password"`
	Port              int     `json:"port"`
	Username          string  `json:"username"`
}

ManagedConnection defines model for ManagedConnection.

type ManagedDatabase

type ManagedDatabase struct {
	// BranchCount Number of live branches of this database. A branch counts until its deletion is requested.
	BranchCount *int `json:"branch_count,omitempty"`

	// BranchLimit Maximum number of live branches allowed on this database. Null means unlimited.
	BranchLimit nullable.Nullable[int] `json:"branch_limit,omitempty"`
	Connection  *ManagedConnection     `json:"connection,omitempty"`
	CreatedAt   string                 `json:"created_at"`

	// DeletionProtection Whether deletion protection is enabled.
	DeletionProtection *bool `json:"deletion_protection,omitempty"`

	// DisplayName Display name of the database. Null if not set.
	DisplayName nullable.Nullable[string] `json:"display_name,omitempty"`
	Domain      *string                   `json:"domain,omitempty"`
	Id          string                    `json:"id"`

	// IpAllowlist Source addresses permitted to reach the Postgres endpoint, with the posture the rules express. Each service reports its own allowlist on its entry in services.
	IpAllowlist IPAllowlist `json:"ip_allowlist"`
	Name        string      `json:"name"`
	Options     *[]string   `json:"options,omitempty"`
	PgVersion   *string     `json:"pg_version,omitempty"`

	// Port Externally reachable Postgres port.
	Port   *int   `json:"port,omitempty"`
	Region string `json:"region"`

	// Services AI services provisioned on the database.
	Services *[]ServiceConfig `json:"services,omitempty"`

	// Size Current managed size name (e.g. "small", "large").
	Size        string `json:"size"`
	Status      string `json:"status"`
	StorageUsed *int64 `json:"storage_used,omitempty"`
	UpdatedAt   string `json:"updated_at"`
}

ManagedDatabase defines model for ManagedDatabase.

type ManagedPGVersion

type ManagedPGVersion struct {
	// Default Whether this is the version a create that omits pg_version
	// provisions. Exactly one version is the default.
	Default bool `json:"default"`

	// Version Postgres major version, as accepted by the pg_version field
	// on database creation (e.g. "18").
	Version string `json:"version"`
}

ManagedPGVersion A Postgres major version a managed database can run.

type ManagedRegion

type ManagedRegion struct {
	// Region Provider region identifier (e.g. "us-east-1").
	Region string `json:"region"`
}

ManagedRegion A region that can host a managed database.

type Message

type Message struct {
	Level    string  `json:"level"`
	Progress *int    `json:"progress,omitempty"`
	Status   *string `json:"status,omitempty"`
	Step     *string `json:"step,omitempty"`
	Text     string  `json:"text"`
	Time     string  `json:"time"`
}

Message defines model for Message.

type MetricSeries

type MetricSeries struct {
	Columns []string        `json:"columns"`
	Name    string          `json:"name"`
	Values  [][]interface{} `json:"values"`
}

MetricSeries defines model for MetricSeries.

type MetricSeriesContainer

type MetricSeriesContainer struct {
	Series []MetricSeries `json:"series"`
}

MetricSeriesContainer defines model for MetricSeriesContainer.

type OpenApiSpec

type OpenApiSpec = map[string]interface{}

OpenApiSpec defines model for OpenApiSpec.

type PostgRESTServiceConfig

type PostgRESTServiceConfig struct {
	// CorsOrigins Optional comma-separated list of allowed CORS origins.
	CorsOrigins *string `json:"cors_origins,omitempty"`

	// DbAnonRole Postgres role used for unauthenticated requests.
	DbAnonRole string `json:"db_anon_role"`

	// DbPool Number of DB connections to keep open (1-30). Defaults to 10.
	DbPool *int `json:"db_pool,omitempty"`

	// DbSchemas Comma-separated Postgres schemas to expose as REST (e.g. "public" or "public,api").
	DbSchemas string `json:"db_schemas"`

	// JwtAudience Optional JWT audience claim.
	JwtAudience *string `json:"jwt_audience,omitempty"`

	// JwtRoleClaimKey Optional JSONPath to the JWT role claim.
	JwtRoleClaimKey *string `json:"jwt_role_claim_key,omitempty"`

	// JwtSecret Optional JWT signing secret (min 32 chars). Write-only; stored in AWS Secrets Manager and never returned.
	JwtSecret *string `json:"jwt_secret,omitempty"`

	// MaxRows Maximum rows returned per request (1-10000). Defaults to 1000.
	MaxRows *int `json:"max_rows,omitempty"`
}

PostgRESTServiceConfig defines model for PostgRESTServiceConfig.

type RAGCorsConfig

type RAGCorsConfig struct {
	// AllowedOrigins Allowed origins when CORS is enabled (e.g. "https://app.example.com").
	AllowedOrigins *[]string `json:"allowed_origins,omitempty"`

	// Enabled Whether CORS is enabled.
	Enabled bool `json:"enabled"`
}

RAGCorsConfig defines model for RAGCorsConfig.

type RAGEmbeddingTable

type RAGEmbeddingTable struct {
	// Filter SQL WHERE clause to scope searches (e.g. "tenant_id = '123'").
	Filter *string `json:"filter,omitempty"`

	// IdColumn Primary key column. Defaults to "id".
	IdColumn *string `json:"id_column,omitempty"`

	// Table Postgres table name (e.g. "public.documents").
	Table string `json:"table"`

	// TextColumn Column containing the text chunk.
	TextColumn string `json:"text_column"`

	// VectorColumn Column containing the embedding vector.
	VectorColumn string `json:"vector_column"`
}

RAGEmbeddingTable defines model for RAGEmbeddingTable.

type RAGLLMConfig

type RAGLLMConfig struct {
	// ApiKey API key for the LLM provider. Write-only; stored in AWS Secrets Manager.
	ApiKey *string `json:"api_key,omitempty"`

	// Model Model identifier passed to the LLM provider.
	Model string `json:"model"`

	// Provider LLM provider.
	Provider RAGLLMConfigProvider `json:"provider"`
}

RAGLLMConfig defines model for RAGLLMConfig.

type RAGLLMConfigProvider

type RAGLLMConfigProvider string

RAGLLMConfigProvider LLM provider.

const (
	RAGLLMConfigProviderAnthropic RAGLLMConfigProvider = "anthropic"
	RAGLLMConfigProviderOpenai    RAGLLMConfigProvider = "openai"
)

Defines values for RAGLLMConfigProvider.

func (RAGLLMConfigProvider) Valid

func (e RAGLLMConfigProvider) Valid() bool

Valid indicates whether the value is a known member of the RAGLLMConfigProvider enum.

type RAGPipelineConfig

type RAGPipelineConfig struct {
	// CompletionLlm Override the RAG server completion LLM for this pipeline. Inherits from RAGServiceConfig when omitted.
	CompletionLlm *RAGLLMConfig `json:"completion_llm,omitempty"`
	Description   *string       `json:"description,omitempty"`

	// EmbeddingLlm Override the RAG server embedding LLM for this pipeline. Inherits from RAGServiceConfig when omitted.
	EmbeddingLlm *RAGLLMConfig `json:"embedding_llm,omitempty"`

	// HybridEnabled Enable hybrid search. Defaults to true.
	HybridEnabled *bool `json:"hybrid_enabled,omitempty"`

	// MinSimilarity Minimum cosine similarity (0.0-1.0) a result must meet to reach the LLM. Guards grounded answers against irrelevant matches. Defaults to 0.0 (no floor).
	MinSimilarity *float64 `json:"min_similarity,omitempty"`

	// Name Pipeline name. Used in request paths.
	Name string `json:"name"`

	// SystemPrompt System prompt for the LLM. Defaults to RAG server built-in prompt.
	SystemPrompt *string `json:"system_prompt,omitempty"`

	// Tables Embedding tables this pipeline searches.
	Tables []RAGEmbeddingTable `json:"tables"`

	// TokenBudget Max tokens for completion. Inherits from RAGServiceConfig when omitted.
	TokenBudget *int `json:"token_budget,omitempty"`

	// TopN Number of results to retrieve. Inherits from RAGServiceConfig when omitted.
	TopN *int `json:"top_n,omitempty"`

	// VectorWeight Weight for vector search in hybrid mode (0.0-1.0). Defaults to 0.5.
	VectorWeight *float64 `json:"vector_weight,omitempty"`
}

RAGPipelineConfig defines model for RAGPipelineConfig.

type RAGServiceConfig

type RAGServiceConfig struct {
	// CompletionLlm Default completion LLM for all pipelines.
	CompletionLlm RAGLLMConfig `json:"completion_llm"`

	// Cors HTTP CORS policy for the RAG server. Off by default; enable when a browser-hosted client calls the service from another origin.
	Cors *RAGCorsConfig `json:"cors,omitempty"`

	// EmbeddingLlm Default embedding LLM for all pipelines.
	EmbeddingLlm RAGLLMConfig        `json:"embedding_llm"`
	Pipelines    []RAGPipelineConfig `json:"pipelines"`

	// TokenBudget Default max completion tokens across all pipelines. Defaults to 1000.
	TokenBudget *int `json:"token_budget,omitempty"`

	// TopN Default number of results to retrieve. Defaults to 10.
	TopN *int `json:"top_n,omitempty"`
}

RAGServiceConfig defines model for RAGServiceConfig.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type ResizeManagedDatabaseInput

type ResizeManagedDatabaseInput struct {
	// Size Target managed size name (e.g. "large").
	Size string `json:"size"`
}

ResizeManagedDatabaseInput defines model for ResizeManagedDatabaseInput.

type ResizeManagedDatabaseJSONRequestBody

type ResizeManagedDatabaseJSONRequestBody = ResizeManagedDatabaseInput

ResizeManagedDatabaseJSONRequestBody defines body for ResizeManagedDatabase for application/json ContentType.

type ResizeManagedDatabaseResponse

type ResizeManagedDatabaseResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *Error
	JSON401      *Error
	JSON402      *Error
	JSON409      *Error
	JSONDefault  *Error
}

func ParseResizeManagedDatabaseResponse

func ParseResizeManagedDatabaseResponse(rsp *http.Response) (*ResizeManagedDatabaseResponse, error)

ParseResizeManagedDatabaseResponse parses an HTTP response from a ResizeManagedDatabaseWithResponse call

func (ResizeManagedDatabaseResponse) ContentType

func (r ResizeManagedDatabaseResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ResizeManagedDatabaseResponse) Status

Status returns HTTPResponse.Status

func (ResizeManagedDatabaseResponse) StatusCode

func (r ResizeManagedDatabaseResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RestoreManagedDatabaseJSONRequestBody

type RestoreManagedDatabaseJSONRequestBody = CreateRestoreRequest

RestoreManagedDatabaseJSONRequestBody defines body for RestoreManagedDatabase for application/json ContentType.

type RestoreManagedDatabaseResponse

type RestoreManagedDatabaseResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *ManagedDatabase
	JSON400      *Error
	JSON401      *Error
	JSON404      *Error
	JSON409      *Error
	JSONDefault  *Error
}

func ParseRestoreManagedDatabaseResponse

func ParseRestoreManagedDatabaseResponse(rsp *http.Response) (*RestoreManagedDatabaseResponse, error)

ParseRestoreManagedDatabaseResponse parses an HTTP response from a RestoreManagedDatabaseWithResponse call

func (RestoreManagedDatabaseResponse) ContentType

func (r RestoreManagedDatabaseResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RestoreManagedDatabaseResponse) Status

Status returns HTTPResponse.Status

func (RestoreManagedDatabaseResponse) StatusCode

func (r RestoreManagedDatabaseResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RotateManagedDatabaseRolePasswordParamsRoleName

type RotateManagedDatabaseRolePasswordParamsRoleName string

RotateManagedDatabaseRolePasswordParamsRoleName defines parameters for RotateManagedDatabaseRolePassword.

Defines values for RotateManagedDatabaseRolePasswordParamsRoleName.

func (RotateManagedDatabaseRolePasswordParamsRoleName) Valid

Valid indicates whether the value is a known member of the RotateManagedDatabaseRolePasswordParamsRoleName enum.

type RotateManagedDatabaseRolePasswordResponse

type RotateManagedDatabaseRolePasswordResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *Error
	JSON401      *Error
	JSON409      *Error
	JSON500      *Error
}

func ParseRotateManagedDatabaseRolePasswordResponse

func ParseRotateManagedDatabaseRolePasswordResponse(rsp *http.Response) (*RotateManagedDatabaseRolePasswordResponse, error)

ParseRotateManagedDatabaseRolePasswordResponse parses an HTTP response from a RotateManagedDatabaseRolePasswordWithResponse call

func (RotateManagedDatabaseRolePasswordResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RotateManagedDatabaseRolePasswordResponse) Status

Status returns HTTPResponse.Status

func (RotateManagedDatabaseRolePasswordResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type ServiceConfig

type ServiceConfig struct {
	// HostIds Cluster host IDs to deploy this service on. Omit to deploy on all database node hosts.
	HostIds *[]string `json:"host_ids,omitempty"`

	// IpAllowlist Source addresses permitted to reach this service's endpoint. A new service that omits it starts closed and reaches nobody until a rule is added; an existing service that omits it keeps its current rules.
	IpAllowlist *IPAllowlist `json:"ip_allowlist,omitempty"`

	// McpConfig MCP service configuration. Only the generate_embedding / embedding block is exposed here. NLA / web chat proxy (llm.*) configuration is not yet exposed through the SaaS API.
	McpConfig *MCPServiceConfig `json:"mcp_config,omitempty"`

	// Port Host port for the service. Present in responses; assigned server-side based on service type.
	Port            *int                    `json:"port,omitempty"`
	PostgrestConfig *PostgRESTServiceConfig `json:"postgrest_config,omitempty"`

	// PublicDomain Public DNS name for this service (the database's domain). Null when the domain is not yet assigned. Managed services share this name and are routed by path; see uri for the full base URL.
	PublicDomain nullable.Nullable[string] `json:"public_domain,omitempty"`
	RagConfig    *RAGServiceConfig         `json:"rag_config,omitempty"`

	// ServiceId SaaS-generated 8-char hex ID. Present in responses;
	// omitted on create (assigned server-side).
	ServiceId *string `json:"service_id,omitempty"`

	// ServiceType Type of service to deploy.
	ServiceType ServiceConfigServiceType `json:"service_type"`

	// State Runtime state of the service, observed on the deployment actually serving it: "running" once it is serving its current configuration, "failed" if it did not come up, and "pending" while a change to the database is still being applied. A configuration change is live on a service only once this reads "running" again.
	State *string `json:"state,omitempty"`

	// TargetNodes Ordered list of database node names to include in the MCP service connection string. Nodes are tried in the order listed. Omit to connect to all nodes with the local node first.
	TargetNodes *[]string `json:"target_nodes,omitempty"`

	// Uri Base URL to call this service on, e.g. https://my-db.us-east-2.pgedge.cloud/mcp/v1. Omitted until the database's domain is assigned, as public_domain is. MCP additionally requires a bearer token, returned as mcp_config.init_tokens on the single-database or single-branch GET.
	Uri nullable.Nullable[string] `json:"uri,omitempty"`
}

ServiceConfig defines model for ServiceConfig.

type ServiceConfigServiceType

type ServiceConfigServiceType string

ServiceConfigServiceType Type of service to deploy.

const (
	Mcp       ServiceConfigServiceType = "mcp"
	Postgrest ServiceConfigServiceType = "postgrest"
	Rag       ServiceConfigServiceType = "rag"
)

Defines values for ServiceConfigServiceType.

func (ServiceConfigServiceType) Valid

func (e ServiceConfigServiceType) Valid() bool

Valid indicates whether the value is a known member of the ServiceConfigServiceType enum.

type Size

type Size struct {
	// CpuLimit Kubernetes resource quantity string for the CPU limit
	// (e.g. "2000m").
	CpuLimit string `json:"cpu_limit"`

	// CpuRequest Kubernetes resource quantity string for the CPU request
	// (e.g. "500m").
	CpuRequest string `json:"cpu_request"`

	// CreatedAt RFC3339 timestamp the row was inserted.
	CreatedAt time.Time `json:"created_at"`

	// DeprecatedAt RFC3339 timestamp the row was deprecated. Non-null iff
	// status is deprecated or retired.
	DeprecatedAt nullable.Nullable[time.Time] `json:"deprecated_at,omitempty"`

	// DisplayName Marketing-copy label shown in the GUI.
	DisplayName string `json:"display_name"`

	// Id The unique identifier of the managed-size row.
	Id string `json:"id"`

	// MemoryLimit Kubernetes resource quantity string for the memory limit
	// (e.g. "4Gi").
	MemoryLimit string `json:"memory_limit"`

	// MemoryRequest Kubernetes resource quantity string for the memory request
	// (e.g. "1Gi").
	MemoryRequest string `json:"memory_request"`

	// Name Customer-visible size identifier (e.g. "small", "large",
	// "xl"). Stable across versions.
	Name string `json:"name"`

	// PostgresSettings Per-size Postgres tuning map. Keys map 1:1 to keys CNPG
	// copies into spec.postgresql.parameters. Values are strings
	// because postgresql.conf parses every value as a string.
	PostgresSettings map[string]string `json:"postgres_settings"`

	// Pricing Current price for a managed size. Present only when the request
	// asked for it via include=pricing, and only for sizes that have
	// a configured price — a size with no price omits the field
	// rather than reporting zero.
	Pricing *SizePricing `json:"pricing,omitempty"`

	// QosClass Kubernetes pod QoS class the managed database runs under.
	QosClass SizeQosClass `json:"qos_class"`

	// RetiredAt RFC3339 timestamp the row was retired. Non-null iff status
	// is retired.
	RetiredAt nullable.Nullable[time.Time] `json:"retired_at,omitempty"`

	// SharedMemorySize Kubernetes resource quantity string for the shared memory size (e.g. "1Gi").
	SharedMemorySize string `json:"shared_memory_size"`

	// Status Lifecycle state of the managed-size row.
	Status SizeStatus `json:"status"`

	// StorageSize Kubernetes resource quantity string for the persistent
	// volume size (e.g. "25Gi").
	StorageSize string `json:"storage_size"`

	// TemporaryDataSize Kubernetes resource quantity string for the temporary data size (e.g. "2Gi").
	TemporaryDataSize string `json:"temporary_data_size"`

	// Version Monotonically increasing version number per name. Starts
	// at 1.
	Version int `json:"version"`
}

Size A single managed-K8s size definition. Shape fields (name, version, qos_class, the K8s quantity strings, and postgres_settings) are immutable for the lifetime of a row; a size-shape change is modeled as a new row at the next version. The mutable fields are display_name and status.

type SizePricing

type SizePricing struct {
	// BillingInterval Interval the price recurs on (e.g. "month").
	BillingInterval string `json:"billing_interval"`

	// Currency ISO 4217 currency code, lowercase.
	Currency string `json:"currency"`

	// PriceAmount Price in the currency's smallest unit (e.g. cents for usd).
	PriceAmount int64 `json:"price_amount"`
}

SizePricing Current price for a managed size. Present only when the request asked for it via include=pricing, and only for sizes that have a configured price — a size with no price omits the field rather than reporting zero.

type SizeQosClass

type SizeQosClass string

SizeQosClass Kubernetes pod QoS class the managed database runs under.

const (
	Burstable  SizeQosClass = "burstable"
	Guaranteed SizeQosClass = "guaranteed"
)

Defines values for SizeQosClass.

func (SizeQosClass) Valid

func (e SizeQosClass) Valid() bool

Valid indicates whether the value is a known member of the SizeQosClass enum.

type SizeStatus

type SizeStatus string

SizeStatus Lifecycle state of the managed-size row.

const (
	Active     SizeStatus = "active"
	Deprecated SizeStatus = "deprecated"
	Retired    SizeStatus = "retired"
)

Defines values for SizeStatus.

func (SizeStatus) Valid

func (e SizeStatus) Valid() bool

Valid indicates whether the value is a known member of the SizeStatus enum.

type Task

type Task struct {
	CreatedAt   string                  `json:"created_at"`
	Error       *string                 `json:"error,omitempty"`
	Id          string                  `json:"id"`
	Messages    []Message               `json:"messages"`
	Name        string                  `json:"name"`
	Request     *map[string]interface{} `json:"request,omitempty"`
	Response    *map[string]interface{} `json:"response,omitempty"`
	Status      string                  `json:"status"`
	SubjectId   string                  `json:"subject_id"`
	SubjectKind string                  `json:"subject_kind"`
	UpdatedAt   string                  `json:"updated_at"`
}

Task defines model for Task.

type UUID

type UUID = openapi_types.UUID

UUID is an alias for openapi_types.UUID used by the generated client code.

type UpdateManagedDatabaseInput

type UpdateManagedDatabaseInput struct {
	// DeletionProtection Whether deletion protection is enabled. When true, delete requests are rejected until protection is disabled.
	DeletionProtection *bool `json:"deletion_protection,omitempty"`

	// DisplayName Display name for the database. Set to null to remove
	// the existing display name.
	DisplayName nullable.Nullable[string] `json:"display_name,omitempty"`

	// IpAllowlist Source addresses permitted to reach the Postgres endpoint. Replaces the current rules; pass empty rules to close the endpoint. Omitted, the rules are unchanged. Each service's allowlist rides its entry in services.
	//
	// Like any other modification, the change is applied one at a time: the database must be "available" and moves through "modifying" while the rules are pushed to the ingress. Postgres is not restarted and open sessions are not cut; the rules govern new connections.
	IpAllowlist *IPAllowlist `json:"ip_allowlist,omitempty"`
	Options     *[]string    `json:"options,omitempty"`

	// Services AI services to provision on the database. Replaces the current service list on update.
	Services *[]ServiceConfig `json:"services,omitempty"`
}

UpdateManagedDatabaseInput defines model for UpdateManagedDatabaseInput.

type UpdateManagedDatabaseJSONRequestBody

type UpdateManagedDatabaseJSONRequestBody = UpdateManagedDatabaseInput

UpdateManagedDatabaseJSONRequestBody defines body for UpdateManagedDatabase for application/json ContentType.

type UpdateManagedDatabaseResponse

type UpdateManagedDatabaseResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ManagedDatabase
	JSON400      *Error
	JSON401      *Error
	JSON409      *Error
	JSONDefault  *Error
}

func ParseUpdateManagedDatabaseResponse

func ParseUpdateManagedDatabaseResponse(rsp *http.Response) (*UpdateManagedDatabaseResponse, error)

ParseUpdateManagedDatabaseResponse parses an HTTP response from a UpdateManagedDatabaseWithResponse call

func (UpdateManagedDatabaseResponse) ContentType

func (r UpdateManagedDatabaseResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateManagedDatabaseResponse) Status

Status returns HTTPResponse.Status

func (UpdateManagedDatabaseResponse) StatusCode

func (r UpdateManagedDatabaseResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL