api

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Sep 9, 2026 License: Apache-2.0 Imports: 15 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.8.0 DO NOT EDIT.

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

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

Index

Constants

This section is empty.

Variables

View Source 
var HTTPClient = &http.Client{
	Timeout:   30 * time.Second,
	Transport: userAgentTransport{},
}

HTTPClient is the shared HTTP client all outgoing requests should use, giving every request a 30-second timeout and the CLI's User-Agent by default. A call that needs a shorter bound should layer a context.WithTimeout over the call rather than build a separate client; a call that needs a longer one (e.g. downloading a large release archive) is a legitimate reason to use a dedicated client instead.

Functions

func NewAttachServiceToVPCRequest 

func NewAttachServiceToVPCRequest(server string, projectID ProjectID, serviceID ServiceID, body AttachServiceToVPCJSONRequestBody) (*http.Request, error)

NewAttachServiceToVPCRequest calls the generic AttachServiceToVPC builder with application/json body

func NewAttachServiceToVPCRequestWithBody 

func NewAttachServiceToVPCRequestWithBody(server string, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader) (*http.Request, error)

NewAttachServiceToVPCRequestWithBody constructs an http.Request for the AttachServiceToVPC method, with any body, and a specified content type

func NewCreateReplicaSetRequest 

func NewCreateReplicaSetRequest(server string, projectID ProjectID, serviceID ServiceID, body CreateReplicaSetJSONRequestBody) (*http.Request, error)

NewCreateReplicaSetRequest calls the generic CreateReplicaSet builder with application/json body

func NewCreateReplicaSetRequestWithBody 

func NewCreateReplicaSetRequestWithBody(server string, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader) (*http.Request, error)

NewCreateReplicaSetRequestWithBody constructs an http.Request for the CreateReplicaSet method, with any body, and a specified content type

func NewCreateServiceRequest 

func NewCreateServiceRequest(server string, projectID ProjectID, body CreateServiceJSONRequestBody) (*http.Request, error)

NewCreateServiceRequest calls the generic CreateService builder with application/json body

func NewCreateServiceRequestWithBody 

func NewCreateServiceRequestWithBody(server string, projectID ProjectID, contentType string, body io.Reader) (*http.Request, error)

NewCreateServiceRequestWithBody constructs an http.Request for the CreateService method, with any body, and a specified content type

func NewCreateVPCPeeringRequest 

func NewCreateVPCPeeringRequest(server string, projectID ProjectID, vpcID VPCId, body CreateVPCPeeringJSONRequestBody) (*http.Request, error)

NewCreateVPCPeeringRequest calls the generic CreateVPCPeering builder with application/json body

func NewCreateVPCPeeringRequestWithBody 

func NewCreateVPCPeeringRequestWithBody(server string, projectID ProjectID, vpcID VPCId, contentType string, body io.Reader) (*http.Request, error)

NewCreateVPCPeeringRequestWithBody constructs an http.Request for the CreateVPCPeering method, with any body, and a specified content type

func NewCreateVPCRequest 

func NewCreateVPCRequest(server string, projectID ProjectID, body CreateVPCJSONRequestBody) (*http.Request, error)

NewCreateVPCRequest calls the generic CreateVPC builder with application/json body

func NewCreateVPCRequestWithBody 

func NewCreateVPCRequestWithBody(server string, projectID ProjectID, contentType string, body io.Reader) (*http.Request, error)

NewCreateVPCRequestWithBody constructs an http.Request for the CreateVPC method, with any body, and a specified content type

func NewDeleteReplicaSetRequest 

func NewDeleteReplicaSetRequest(server string, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID) (*http.Request, error)

NewDeleteReplicaSetRequest constructs an http.Request for the DeleteReplicaSet method

func NewDeleteServiceRequest 

func NewDeleteServiceRequest(server string, projectID ProjectID, serviceID ServiceID) (*http.Request, error)

NewDeleteServiceRequest constructs an http.Request for the DeleteService method

func NewDeleteVPCPeeringRequest 

func NewDeleteVPCPeeringRequest(server string, projectID ProjectID, vpcID VPCId, peeringID PeeringID) (*http.Request, error)

NewDeleteVPCPeeringRequest constructs an http.Request for the DeleteVPCPeering method

func NewDeleteVPCRequest 

func NewDeleteVPCRequest(server string, projectID ProjectID, vpcID VPCId) (*http.Request, error)

NewDeleteVPCRequest constructs an http.Request for the DeleteVPC method

func NewDetachServiceFromVPCRequest 

func NewDetachServiceFromVPCRequest(server string, projectID ProjectID, serviceID ServiceID, body DetachServiceFromVPCJSONRequestBody) (*http.Request, error)

NewDetachServiceFromVPCRequest calls the generic DetachServiceFromVPC builder with application/json body

func NewDetachServiceFromVPCRequestWithBody 

func NewDetachServiceFromVPCRequestWithBody(server string, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader) (*http.Request, error)

NewDetachServiceFromVPCRequestWithBody constructs an http.Request for the DetachServiceFromVPC method, with any body, and a specified content type

func NewDisablePoolerRequest 

func NewDisablePoolerRequest(server string, projectID ProjectID, serviceID ServiceID) (*http.Request, error)

NewDisablePoolerRequest constructs an http.Request for the DisablePooler method

func NewDisableReplicaPoolerRequest 

func NewDisableReplicaPoolerRequest(server string, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID) (*http.Request, error)

NewDisableReplicaPoolerRequest constructs an http.Request for the DisableReplicaPooler method

func NewEnablePoolerRequest 

func NewEnablePoolerRequest(server string, projectID ProjectID, serviceID ServiceID) (*http.Request, error)

NewEnablePoolerRequest constructs an http.Request for the EnablePooler method

func NewEnableReplicaPoolerRequest 

func NewEnableReplicaPoolerRequest(server string, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID) (*http.Request, error)

NewEnableReplicaPoolerRequest constructs an http.Request for the EnableReplicaPooler method

func NewForkServiceRequest 

func NewForkServiceRequest(server string, projectID ProjectID, serviceID ServiceID, body ForkServiceJSONRequestBody) (*http.Request, error)

NewForkServiceRequest calls the generic ForkService builder with application/json body

func NewForkServiceRequestWithBody 

func NewForkServiceRequestWithBody(server string, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader) (*http.Request, error)

NewForkServiceRequestWithBody constructs an http.Request for the ForkService method, with any body, and a specified content type

func NewGetAuthInfoRequest 

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

NewGetAuthInfoRequest constructs an http.Request for the GetAuthInfo method

func NewGetBackupsRequest added in v0.23.0 

func NewGetBackupsRequest(server string, projectID ProjectID, serviceID ServiceID) (*http.Request, error)

NewGetBackupsRequest constructs an http.Request for the GetBackups method

func NewGetProjectsRequest 

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

NewGetProjectsRequest constructs an http.Request for the GetProjects method

func NewGetReplicaSetsRequest 

func NewGetReplicaSetsRequest(server string, projectID ProjectID, serviceID ServiceID) (*http.Request, error)

NewGetReplicaSetsRequest constructs an http.Request for the GetReplicaSets method

func NewGetServiceLogsRequest 

func NewGetServiceLogsRequest(server string, projectID ProjectID, serviceID ServiceID, params *GetServiceLogsParams) (*http.Request, error)

NewGetServiceLogsRequest constructs an http.Request for the GetServiceLogs method

func NewGetServiceMetricsAvailableSeriesRequest 

func NewGetServiceMetricsAvailableSeriesRequest(server string, projectID ProjectID, serviceID ServiceID) (*http.Request, error)

NewGetServiceMetricsAvailableSeriesRequest constructs an http.Request for the GetServiceMetricsAvailableSeries method

func NewGetServiceMetricsSeriesRequest 

func NewGetServiceMetricsSeriesRequest(server string, projectID ProjectID, serviceID ServiceID, body GetServiceMetricsSeriesJSONRequestBody) (*http.Request, error)

NewGetServiceMetricsSeriesRequest calls the generic GetServiceMetricsSeries builder with application/json body

func NewGetServiceMetricsSeriesRequestWithBody 

func NewGetServiceMetricsSeriesRequestWithBody(server string, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader) (*http.Request, error)

NewGetServiceMetricsSeriesRequestWithBody constructs an http.Request for the GetServiceMetricsSeries method, with any body, and a specified content type

func NewGetServiceRequest 

func NewGetServiceRequest(server string, projectID ProjectID, serviceID ServiceID) (*http.Request, error)

NewGetServiceRequest constructs an http.Request for the GetService method

func NewGetServicesRequest 

func NewGetServicesRequest(server string, projectID ProjectID) (*http.Request, error)

NewGetServicesRequest constructs an http.Request for the GetServices method

func NewGetVPCPeeringRequest 

func NewGetVPCPeeringRequest(server string, projectID ProjectID, vpcID VPCId, peeringID PeeringID) (*http.Request, error)

NewGetVPCPeeringRequest constructs an http.Request for the GetVPCPeering method

func NewGetVPCPeeringsRequest 

func NewGetVPCPeeringsRequest(server string, projectID ProjectID, vpcID VPCId) (*http.Request, error)

NewGetVPCPeeringsRequest constructs an http.Request for the GetVPCPeerings method

func NewGetVPCRequest 

func NewGetVPCRequest(server string, projectID ProjectID, vpcID VPCId) (*http.Request, error)

NewGetVPCRequest constructs an http.Request for the GetVPC method

func NewGetVPCsRequest 

func NewGetVPCsRequest(server string, projectID ProjectID) (*http.Request, error)

NewGetVPCsRequest constructs an http.Request for the GetVPCs method

func NewIdentifyUserRequest 

func NewIdentifyUserRequest(server string, body IdentifyUserJSONRequestBody) (*http.Request, error)

NewIdentifyUserRequest calls the generic IdentifyUser builder with application/json body

func NewIdentifyUserRequestWithBody 

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

NewIdentifyUserRequestWithBody constructs an http.Request for the IdentifyUser method, with any body, and a specified content type

func NewLogoutRequest 

func NewLogoutRequest(server string, body LogoutJSONRequestBody) (*http.Request, error)

NewLogoutRequest calls the generic Logout builder with application/json body

func NewLogoutRequestWithBody 

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

NewLogoutRequestWithBody constructs an http.Request for the Logout method, with any body, and a specified content type

func NewRenameServiceRequest 

func NewRenameServiceRequest(server string, projectID ProjectID, serviceID ServiceID, body RenameServiceJSONRequestBody) (*http.Request, error)

NewRenameServiceRequest calls the generic RenameService builder with application/json body

func NewRenameServiceRequestWithBody 

func NewRenameServiceRequestWithBody(server string, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader) (*http.Request, error)

NewRenameServiceRequestWithBody constructs an http.Request for the RenameService method, with any body, and a specified content type

func NewRenameVPCRequest 

func NewRenameVPCRequest(server string, projectID ProjectID, vpcID VPCId, body RenameVPCJSONRequestBody) (*http.Request, error)

NewRenameVPCRequest calls the generic RenameVPC builder with application/json body

func NewRenameVPCRequestWithBody 

func NewRenameVPCRequestWithBody(server string, projectID ProjectID, vpcID VPCId, contentType string, body io.Reader) (*http.Request, error)

NewRenameVPCRequestWithBody constructs an http.Request for the RenameVPC method, with any body, and a specified content type

func NewResizeReplicaSetRequest 

func NewResizeReplicaSetRequest(server string, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, body ResizeReplicaSetJSONRequestBody) (*http.Request, error)

NewResizeReplicaSetRequest calls the generic ResizeReplicaSet builder with application/json body

func NewResizeReplicaSetRequestWithBody 

func NewResizeReplicaSetRequestWithBody(server string, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, contentType string, body io.Reader) (*http.Request, error)

NewResizeReplicaSetRequestWithBody constructs an http.Request for the ResizeReplicaSet method, with any body, and a specified content type

func NewResizeServiceRequest 

func NewResizeServiceRequest(server string, projectID ProjectID, serviceID ServiceID, body ResizeServiceJSONRequestBody) (*http.Request, error)

NewResizeServiceRequest calls the generic ResizeService builder with application/json body

func NewResizeServiceRequestWithBody 

func NewResizeServiceRequestWithBody(server string, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader) (*http.Request, error)

NewResizeServiceRequestWithBody constructs an http.Request for the ResizeService method, with any body, and a specified content type

func NewSetEnvironmentRequest 

func NewSetEnvironmentRequest(server string, projectID ProjectID, serviceID ServiceID, body SetEnvironmentJSONRequestBody) (*http.Request, error)

NewSetEnvironmentRequest calls the generic SetEnvironment builder with application/json body

func NewSetEnvironmentRequestWithBody 

func NewSetEnvironmentRequestWithBody(server string, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader) (*http.Request, error)

NewSetEnvironmentRequestWithBody constructs an http.Request for the SetEnvironment method, with any body, and a specified content type

func NewSetHAReplicaRequest 

func NewSetHAReplicaRequest(server string, projectID ProjectID, serviceID ServiceID, body SetHAReplicaJSONRequestBody) (*http.Request, error)

NewSetHAReplicaRequest calls the generic SetHAReplica builder with application/json body

func NewSetHAReplicaRequestWithBody 

func NewSetHAReplicaRequestWithBody(server string, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader) (*http.Request, error)

NewSetHAReplicaRequestWithBody constructs an http.Request for the SetHAReplica method, with any body, and a specified content type

func NewSetReplicaEnvironmentRequest 

func NewSetReplicaEnvironmentRequest(server string, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, body SetReplicaEnvironmentJSONRequestBody) (*http.Request, error)

NewSetReplicaEnvironmentRequest calls the generic SetReplicaEnvironment builder with application/json body

func NewSetReplicaEnvironmentRequestWithBody 

func NewSetReplicaEnvironmentRequestWithBody(server string, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, contentType string, body io.Reader) (*http.Request, error)

NewSetReplicaEnvironmentRequestWithBody constructs an http.Request for the SetReplicaEnvironment method, with any body, and a specified content type

func NewStartServiceRequest 

func NewStartServiceRequest(server string, projectID ProjectID, serviceID ServiceID) (*http.Request, error)

NewStartServiceRequest constructs an http.Request for the StartService method

func NewStopServiceRequest 

func NewStopServiceRequest(server string, projectID ProjectID, serviceID ServiceID) (*http.Request, error)

NewStopServiceRequest constructs an http.Request for the StopService method

func NewTrackEventRequest 

func NewTrackEventRequest(server string, body TrackEventJSONRequestBody) (*http.Request, error)

NewTrackEventRequest calls the generic TrackEvent builder with application/json body

func NewTrackEventRequestWithBody 

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

NewTrackEventRequestWithBody constructs an http.Request for the TrackEvent method, with any body, and a specified content type

func NewUpdatePasswordRequest 

func NewUpdatePasswordRequest(server string, projectID ProjectID, serviceID ServiceID, body UpdatePasswordJSONRequestBody) (*http.Request, error)

NewUpdatePasswordRequest calls the generic UpdatePassword builder with application/json body

func NewUpdatePasswordRequestWithBody 

func NewUpdatePasswordRequestWithBody(server string, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader) (*http.Request, error)

NewUpdatePasswordRequestWithBody constructs an http.Request for the UpdatePassword method, with any body, and a specified content type

Types

type AnalyticsResponse 

type AnalyticsResponse struct {
	// Status Status of the analytics operation.
	//
	// Example: success
	Status *string `json:"status,omitempty"`
}

AnalyticsResponse defines model for AnalyticsResponse.

type AttachServiceToVPCJSONRequestBody 

type AttachServiceToVPCJSONRequestBody = ServiceVPCInput

AttachServiceToVPCJSONRequestBody defines body for AttachServiceToVPC for application/json ContentType.

type AttachServiceToVPCResponse 

type AttachServiceToVPCResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *SuccessMessage
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseAttachServiceToVPCResponse 

func ParseAttachServiceToVPCResponse(rsp *http.Response) (*AttachServiceToVPCResponse, error)

ParseAttachServiceToVPCResponse parses an HTTP response from a AttachServiceToVPCWithResponse call

func (AttachServiceToVPCResponse) ContentType added in v0.24.0 

func (r AttachServiceToVPCResponse) ContentType() string

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

func (AttachServiceToVPCResponse) GetBody added in v0.24.0 

func (r AttachServiceToVPCResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (AttachServiceToVPCResponse) GetJSON4XX added in v0.24.0 

func (r AttachServiceToVPCResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (AttachServiceToVPCResponse) GetJSON202 added in v0.24.0 

func (r AttachServiceToVPCResponse) GetJSON202() *SuccessMessage

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (AttachServiceToVPCResponse) Status 

func (r AttachServiceToVPCResponse) Status() string

Status returns HTTPResponse.Status

func (AttachServiceToVPCResponse) StatusCode 

func (r AttachServiceToVPCResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AuthInfo 

type AuthInfo struct {
	// APIKeyDeprecated Deprecated. Use `api_key` instead.
	// Deprecated: Use `api_key` instead.
	APIKeyDeprecated *AuthInfoAPIKey `json:"apiKey,omitempty"`

	// APIKey Information about the API key credentials (PAT).
	APIKey *AuthInfoAPIKey `json:"api_key,omitempty"`

	// Oauth OAuth user details. Present for OAuth user callers.
	Oauth *AuthInfoOAuth `json:"oauth,omitempty"`

	// Type Discriminator for the credential shape. `apiKey` for PAT callers; `oauth` for OAuth
	// user callers.
	//
	//
	// Example: apiKey
	Type AuthInfoType `json:"type"`
}

AuthInfo Information about the authentication credentials being used. Exactly one of `api_key` or `oauth` is populated; the `type` field discriminates.

type AuthInfoAPIKey 

type AuthInfoAPIKey struct {
	// Created When the client credentials were created.
	//
	// Example: 2024-01-15T10:30:00Z
	Created time.Time `json:"created"`

	// IssuingUser Information about the user who created the credentials.
	IssuingUser AuthInfoIssuingUser `json:"issuing_user"`

	// Name The name of the credential.
	//
	// Example: my-production-token
	Name string `json:"name"`

	// Project Information about the project.
	Project AuthInfoProject `json:"project"`

	// PublicKey The public key of the client credentials.
	//
	// Example: tskey_abc123
	PublicKey string `json:"public_key"`
}

AuthInfoAPIKey Information about the API key credentials (PAT).

type AuthInfoIssuingUser 

type AuthInfoIssuingUser struct {
	// Email The user's email.
	//
	// Example: john.doe@example.com
	Email openapi_types.Email `json:"email"`

	// ID The user ID.
	//
	// Example: user123
	ID string `json:"id"`

	// Name The user's name.
	//
	// Example: John Doe
	Name string `json:"name"`
}

AuthInfoIssuingUser Information about the user who created the credentials.

type AuthInfoOAuth 

type AuthInfoOAuth struct {
	// User The authenticated OAuth user.
	User AuthInfoUser `json:"user"`
}

AuthInfoOAuth OAuth user details. Present for OAuth user callers.

type AuthInfoProject 

type AuthInfoProject struct {
	// ID The project ID.
	//
	// Example: rp1pz7uyae
	ID string `json:"id"`

	// Name The name of the project.
	//
	// Example: My Production Project
	Name string `json:"name"`

	// PlanType The plan type for the project.
	//
	// Example: FREE
	PlanType string `json:"plan_type"`
}

AuthInfoProject Information about the project.

type AuthInfoType 

type AuthInfoType string

AuthInfoType Discriminator for the credential shape. `apiKey` for PAT callers; `oauth` for OAuth user callers.

Example: apiKey 

const (
	AuthInfoTypeAPIKey AuthInfoType = "apiKey"
	AuthInfoTypeOauth  AuthInfoType = "oauth"
)

Defines values for AuthInfoType.

func (AuthInfoType) Valid added in v0.24.0 

func (e AuthInfoType) Valid() bool

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

type AuthInfoUser 

type AuthInfoUser struct {
	// Email The user's email.
	//
	// Example: john.doe@example.com
	Email openapi_types.Email `json:"email"`

	// ID The numeric user ID.
	//
	// Example: 1234567
	ID string `json:"id"`

	// Name The user's name.
	//
	// Example: John Doe
	Name string `json:"name"`
}

AuthInfoUser The authenticated OAuth user.

type Backup added in v0.23.0 

type Backup struct {
	// DurationSeconds How long the backup took, in seconds. Absent while the backup is still running.
	//
	// Example: 672
	DurationSeconds *int64 `json:"duration_seconds,omitempty"`

	// FinishedAt When the backup finished. Absent while the backup is still running.
	//
	// Example: 2026-01-15T09:41:12Z
	FinishedAt *time.Time `json:"finished_at,omitempty"`

	// Label The label the backup system assigns to this backup.
	//
	// Example: 20260115-093000F
	Label string `json:"label"`

	// Regions Every region storing a copy of this backup: the region the service
	// runs in, plus any region enabled for cross-region backups.
	Regions []BackupRegionState `json:"regions"`

	// SizeBytes The size of the backup in bytes. Absent while the backup is still running.
	//
	// Example: 4831838208
	SizeBytes *int64 `json:"size_bytes,omitempty"`

	// StartedAt When the backup started.
	//
	// Example: 2026-01-15T09:30:00Z
	StartedAt time.Time `json:"started_at"`

	// Type The type of the backup.
	Type BackupType `json:"type"`
}

Backup A single backup of a service, taken automatically by Tiger Cloud.

type BackupCopyStatus added in v0.23.0 

type BackupCopyStatus string

BackupCopyStatus The state of a copy of a backup in one region.

- `SCHEDULED`: the copy has not started yet. - `RUNNING`: the copy is in progress. - `RETRYING`: the copy failed and is being retried. - `FINISHED`: the copy completed successfully. - `FAILED`: the copy did not complete. - `UNKNOWN`: an unrecognized state. 

const (
	BackupCopyStatusFAILED    BackupCopyStatus = "FAILED"
	BackupCopyStatusFINISHED  BackupCopyStatus = "FINISHED"
	BackupCopyStatusRETRYING  BackupCopyStatus = "RETRYING"
	BackupCopyStatusRUNNING   BackupCopyStatus = "RUNNING"
	BackupCopyStatusSCHEDULED BackupCopyStatus = "SCHEDULED"
	BackupCopyStatusUNKNOWN   BackupCopyStatus = "UNKNOWN"
)

Defines values for BackupCopyStatus.

func (BackupCopyStatus) Valid added in v0.24.0 

func (e BackupCopyStatus) Valid() bool

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

type BackupRegionState added in v0.23.0 

type BackupRegionState struct {
	// RegionCode The region storing the copy.
	//
	// Example: eu-central-1
	RegionCode string `json:"region_code"`

	// Status The state of this copy.
	Status *BackupCopyStatus `json:"status,omitempty"`
}

BackupRegionState A region storing a copy of a backup.

type BackupType added in v0.23.0 

type BackupType string

BackupType The type of a backup.

- `FULL`: a complete copy of the service's data. - `INCREMENTAL`: only the data that changed since the previous backup. - `UNKNOWN`: a type this version of the API does not name. 

const (
	BackupTypeFULL        BackupType = "FULL"
	BackupTypeINCREMENTAL BackupType = "INCREMENTAL"
	BackupTypeUNKNOWN     BackupType = "UNKNOWN"
)

Defines values for BackupType.

func (BackupType) Valid added in v0.24.0 

func (e BackupType) Valid() bool

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

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) AttachServiceToVPC 

func (c *Client) AttachServiceToVPC(ctx context.Context, projectID ProjectID, serviceID ServiceID, body AttachServiceToVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

AttachServiceToVPC Attach Service to VPC

Associates a service with a VPC.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/attachToVPC (the `AttachServiceToVPC` operationId).

func (*Client) AttachServiceToVPCWithBody 

func (c *Client) AttachServiceToVPCWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

AttachServiceToVPCWithBody Attach Service to VPC

Associates a service with a VPC.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/attachToVPC (the `AttachServiceToVPC` operationId).

func (*Client) CreateReplicaSet 

func (c *Client) CreateReplicaSet(ctx context.Context, projectID ProjectID, serviceID ServiceID, body CreateReplicaSetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateReplicaSet Create a Read Replica Set

Creates a new read replica set for a service. This is an asynchronous operation.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets (the `CreateReplicaSet` operationId).

func (*Client) CreateReplicaSetWithBody 

func (c *Client) CreateReplicaSetWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateReplicaSetWithBody Create a Read Replica Set

Creates a new read replica set for a service. This is an asynchronous operation.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets (the `CreateReplicaSet` operationId).

func (*Client) CreateService 

func (c *Client) CreateService(ctx context.Context, projectID ProjectID, body CreateServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateService Create a Service

Creates a new database service within a project. This is an asynchronous operation.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/services (the `CreateService` operationId).

func (*Client) CreateServiceWithBody 

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

CreateServiceWithBody Create a Service

Creates a new database service within a project. This is an asynchronous operation.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/services (the `CreateService` operationId).

func (*Client) CreateVPC 

func (c *Client) CreateVPC(ctx context.Context, projectID ProjectID, body CreateVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateVPC Create a VPC

Creates a new Virtual Private Cloud (VPC).

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/vpcs (the `CreateVPC` operationId).

func (*Client) CreateVPCPeering 

func (c *Client) CreateVPCPeering(ctx context.Context, projectID ProjectID, vpcID VPCId, body CreateVPCPeeringJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateVPCPeering Create a VPC Peering

Creates a new VPC peering connection.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/peerings (the `CreateVPCPeering` operationId).

func (*Client) CreateVPCPeeringWithBody 

func (c *Client) CreateVPCPeeringWithBody(ctx context.Context, projectID ProjectID, vpcID VPCId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateVPCPeeringWithBody Create a VPC Peering

Creates a new VPC peering connection.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/peerings (the `CreateVPCPeering` operationId).

func (*Client) CreateVPCWithBody 

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

CreateVPCWithBody Create a VPC

Creates a new Virtual Private Cloud (VPC).

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/vpcs (the `CreateVPC` operationId).

func (*Client) DeleteReplicaSet 

func (c *Client) DeleteReplicaSet(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteReplicaSet Delete a Read Replica Set

Deletes a specific read replica set. This is an asynchronous operation.

Corresponds with DELETE /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id} (the `DeleteReplicaSet` operationId).

func (*Client) DeleteService 

func (c *Client) DeleteService(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteService Delete a Service

Deletes a specific service. This is an asynchronous operation.

Corresponds with DELETE /projects/{project_id}/services/{service_id} (the `DeleteService` operationId).

func (*Client) DeleteVPC 

func (c *Client) DeleteVPC(ctx context.Context, projectID ProjectID, vpcID VPCId, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteVPC Delete a VPC

Deletes a specific VPC.

Corresponds with DELETE /projects/{project_id}/vpcs/{vpc_id} (the `DeleteVPC` operationId).

func (*Client) DeleteVPCPeering 

func (c *Client) DeleteVPCPeering(ctx context.Context, projectID ProjectID, vpcID VPCId, peeringID PeeringID, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteVPCPeering Delete a VPC Peering

Deletes a specific VPC peering connection.

Corresponds with DELETE /projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id} (the `DeleteVPCPeering` operationId).

func (*Client) DetachServiceFromVPC 

func (c *Client) DetachServiceFromVPC(ctx context.Context, projectID ProjectID, serviceID ServiceID, body DetachServiceFromVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

DetachServiceFromVPC Detach Service from VPC

Disassociates a service from its VPC.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/detachFromVPC (the `DetachServiceFromVPC` operationId).

func (*Client) DetachServiceFromVPCWithBody 

func (c *Client) DetachServiceFromVPCWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

DetachServiceFromVPCWithBody Detach Service from VPC

Disassociates a service from its VPC.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/detachFromVPC (the `DetachServiceFromVPC` operationId).

func (*Client) DisablePooler 

func (c *Client) DisablePooler(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

DisablePooler Disable Connection Pooler for a Service

Deactivates the connection pooler for a specific service within a project.

Corresponds with POST /projects/{project_id}/services/{service_id}/disablePooler (the `DisablePooler` operationId).

func (*Client) DisableReplicaPooler 

func (c *Client) DisableReplicaPooler(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, reqEditors ...RequestEditorFn) (*http.Response, error)

DisableReplicaPooler Disable Connection Pooler for a Read Replica

Deactivates the connection pooler for a specific read replica set.

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/disablePooler (the `DisableReplicaPooler` operationId).

func (*Client) EnablePooler 

func (c *Client) EnablePooler(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

EnablePooler Enable Connection Pooler for a Service

Activates the connection pooler for a specific service within a project.

Corresponds with POST /projects/{project_id}/services/{service_id}/enablePooler (the `EnablePooler` operationId).

func (*Client) EnableReplicaPooler 

func (c *Client) EnableReplicaPooler(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, reqEditors ...RequestEditorFn) (*http.Response, error)

EnableReplicaPooler Enable Connection Pooler for a Read Replica

Activates the connection pooler for a specific read replica set.

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/enablePooler (the `EnableReplicaPooler` operationId).

func (*Client) ForkService 

func (c *Client) ForkService(ctx context.Context, projectID ProjectID, serviceID ServiceID, body ForkServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ForkService Fork a Service

Creates a new, independent service within a project by taking a snapshot of an existing one.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/forkService (the `ForkService` operationId).

func (*Client) ForkServiceWithBody 

func (c *Client) ForkServiceWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ForkServiceWithBody Fork a Service

Creates a new, independent service within a project by taking a snapshot of an existing one.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/forkService (the `ForkService` operationId).

func (*Client) GetAuthInfo 

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

GetAuthInfo Get Authentication Info

Returns the authenticated caller's identity. The response shape depends on the credential type: `apiKey` for PAT callers, `oauth` for OAuth user callers. Exactly one of `api_key` or `oauth` is populated; `type` discriminates.

Corresponds with GET /auth/info (the `GetAuthInfo` operationId).

func (*Client) GetBackups added in v0.23.0 

func (c *Client) GetBackups(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

GetBackups List All Backups

**Preview - this endpoint is experimental and may change without notice.**

Retrieves a list of the full and incremental backups taken for a service. Backups run automatically on a schedule; there is no operation to create or delete one. To restore data, create a recovery fork with `fork_strategy: PITR`.

Corresponds with GET /projects/{project_id}/services/{service_id}/backups (the `GetBackups` operationId).

func (*Client) GetProjects 

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

GetProjects List projects accessible to the authenticated caller

Returns the projects the caller can access. PAT callers see only the project their PAT is scoped to; OAuth user callers see all projects they belong to.

Corresponds with GET /projects (the `GetProjects` operationId).

func (*Client) GetReplicaSets 

func (c *Client) GetReplicaSets(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

GetReplicaSets Get Read Replica Sets

Retrieves a list of all read replica sets associated with a primary service within a project.

Corresponds with GET /projects/{project_id}/services/{service_id}/replicaSets (the `GetReplicaSets` operationId).

func (*Client) GetService 

func (c *Client) GetService(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

GetService Get a Service

Retrieves the details of a specific service by its ID.

Corresponds with GET /projects/{project_id}/services/{service_id} (the `GetService` operationId).

func (*Client) GetServiceLogs 

func (c *Client) GetServiceLogs(ctx context.Context, projectID ProjectID, serviceID ServiceID, params *GetServiceLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetServiceLogs Get service logs

Fetch logs for a specific service. Returns up to 500 log entries in reverse chronological order. Supports cursor-based pagination via the `cursor` parameter and the `last_cursor` field in the response.

Use the returned `last_cursor` value as the `cursor` parameter on subsequent requests to page through all available logs.

Corresponds with GET /projects/{project_id}/services/{service_id}/logs (the `GetServiceLogs` operationId).

func (*Client) GetServiceMetricsAvailableSeries 

func (c *Client) GetServiceMetricsAvailableSeries(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

GetServiceMetricsAvailableSeries List available metric series

**Preview — this endpoint is experimental and may change without notice.**

Returns the names of all metric series available for a service.

Corresponds with GET /projects/{project_id}/services/{service_id}/metrics/available-series (the `GetServiceMetricsAvailableSeries` operationId).

func (*Client) GetServiceMetricsSeries 

func (c *Client) GetServiceMetricsSeries(ctx context.Context, projectID ProjectID, serviceID ServiceID, body GetServiceMetricsSeriesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

GetServiceMetricsSeries Get a metric series

**Preview — this endpoint is experimental and may change without notice.**

Returns time-series data points for a named metric within a time window. Use getServiceMetricsAvailableSeries to discover valid metric names.

Parameters are sent as a JSON body so callers can pass an unbounded filter set without query-string length pressure. The response is a list of MetricSeries, each carrying its label set as a structured map alongside its per-bucket data points.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/metrics/series (the `GetServiceMetricsSeries` operationId).

func (*Client) GetServiceMetricsSeriesWithBody 

func (c *Client) GetServiceMetricsSeriesWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

GetServiceMetricsSeriesWithBody Get a metric series

**Preview — this endpoint is experimental and may change without notice.**

Returns time-series data points for a named metric within a time window. Use getServiceMetricsAvailableSeries to discover valid metric names.

Parameters are sent as a JSON body so callers can pass an unbounded filter set without query-string length pressure. The response is a list of MetricSeries, each carrying its label set as a structured map alongside its per-bucket data points.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/metrics/series (the `GetServiceMetricsSeries` operationId).

func (*Client) GetServices 

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

GetServices List All Services

Retrieves a list of all services within a specific project.

Corresponds with GET /projects/{project_id}/services (the `GetServices` operationId).

func (*Client) GetVPC 

func (c *Client) GetVPC(ctx context.Context, projectID ProjectID, vpcID VPCId, reqEditors ...RequestEditorFn) (*http.Response, error)

GetVPC Get a VPC

Retrieves the details of a specific VPC by its ID.

Corresponds with GET /projects/{project_id}/vpcs/{vpc_id} (the `GetVPC` operationId).

func (*Client) GetVPCPeering 

func (c *Client) GetVPCPeering(ctx context.Context, projectID ProjectID, vpcID VPCId, peeringID PeeringID, reqEditors ...RequestEditorFn) (*http.Response, error)

GetVPCPeering Get a VPC Peering

Retrieves the details of a specific VPC peering connection.

Corresponds with GET /projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id} (the `GetVPCPeering` operationId).

func (*Client) GetVPCPeerings 

func (c *Client) GetVPCPeerings(ctx context.Context, projectID ProjectID, vpcID VPCId, reqEditors ...RequestEditorFn) (*http.Response, error)

GetVPCPeerings List VPC Peerings

Retrieves a list of all VPC peering connections for a given VPC.

Corresponds with GET /projects/{project_id}/vpcs/{vpc_id}/peerings (the `GetVPCPeerings` operationId).

func (*Client) GetVPCs 

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

GetVPCs List All VPCs

Retrieves a list of all Virtual Private Clouds (VPCs).

Corresponds with GET /projects/{project_id}/vpcs (the `GetVPCs` operationId).

func (*Client) IdentifyUser 

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

IdentifyUser Identify a user

Identifies a user with optional properties for analytics tracking.

Takes a body of the `application/json` content type.

Corresponds with POST /analytics/identify (the `IdentifyUser` operationId).

func (*Client) IdentifyUserWithBody 

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

IdentifyUserWithBody Identify a user

Identifies a user with optional properties for analytics tracking.

Takes any type of body and a specified content type.

Corresponds with POST /analytics/identify (the `IdentifyUser` operationId).

func (*Client) Logout 

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

Logout Log out and revoke refresh token

Revokes the caller's refresh token server-side. For OAuth Bearer callers, include the refresh token in the request body — it is held client-side and cannot be derived from the access token. Callers without a refresh token to revoke may post an empty body to clear server-side session state best-effort.

Returns 204 No Content on success. The caller is still responsible for dropping any locally-cached credentials.

Takes a body of the `application/json` content type.

Corresponds with POST /auth/logout (the `Logout` operationId).

func (*Client) LogoutWithBody 

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

LogoutWithBody Log out and revoke refresh token

Revokes the caller's refresh token server-side. For OAuth Bearer callers, include the refresh token in the request body — it is held client-side and cannot be derived from the access token. Callers without a refresh token to revoke may post an empty body to clear server-side session state best-effort.

Returns 204 No Content on success. The caller is still responsible for dropping any locally-cached credentials.

Takes any type of body and a specified content type.

Corresponds with POST /auth/logout (the `Logout` operationId).

func (*Client) RenameService 

func (c *Client) RenameService(ctx context.Context, projectID ProjectID, serviceID ServiceID, body RenameServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

RenameService Rename a Service

Updates the name of a specific service.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/rename (the `RenameService` operationId).

func (*Client) RenameServiceWithBody 

func (c *Client) RenameServiceWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

RenameServiceWithBody Rename a Service

Updates the name of a specific service.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/rename (the `RenameService` operationId).

func (*Client) RenameVPC 

func (c *Client) RenameVPC(ctx context.Context, projectID ProjectID, vpcID VPCId, body RenameVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

RenameVPC Rename a VPC

Updates the name of a specific VPC.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/rename (the `RenameVPC` operationId).

func (*Client) RenameVPCWithBody 

func (c *Client) RenameVPCWithBody(ctx context.Context, projectID ProjectID, vpcID VPCId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

RenameVPCWithBody Rename a VPC

Updates the name of a specific VPC.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/rename (the `RenameVPC` operationId).

func (*Client) ResizeReplicaSet 

func (c *Client) ResizeReplicaSet(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, body ResizeReplicaSetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ResizeReplicaSet Resize a Read Replica Set

Changes the resource allocation for a specific read replica set.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/resize (the `ResizeReplicaSet` operationId).

func (*Client) ResizeReplicaSetWithBody 

func (c *Client) ResizeReplicaSetWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ResizeReplicaSetWithBody Resize a Read Replica Set

Changes the resource allocation for a specific read replica set.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/resize (the `ResizeReplicaSet` operationId).

func (*Client) ResizeService 

func (c *Client) ResizeService(ctx context.Context, projectID ProjectID, serviceID ServiceID, body ResizeServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ResizeService Resize a Service

Changes the CPU and memory allocation for a specific service within a project. This is an asynchronous operation.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/resize (the `ResizeService` operationId).

func (*Client) ResizeServiceWithBody 

func (c *Client) ResizeServiceWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ResizeServiceWithBody Resize a Service

Changes the CPU and memory allocation for a specific service within a project. This is an asynchronous operation.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/resize (the `ResizeService` operationId).

func (*Client) SetEnvironment 

func (c *Client) SetEnvironment(ctx context.Context, projectID ProjectID, serviceID ServiceID, body SetEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SetEnvironment Set Environment for a Service

Sets the environment type for the service.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/setEnvironment (the `SetEnvironment` operationId).

func (*Client) SetEnvironmentWithBody 

func (c *Client) SetEnvironmentWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SetEnvironmentWithBody Set Environment for a Service

Sets the environment type for the service.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/setEnvironment (the `SetEnvironment` operationId).

func (*Client) SetHAReplica 

func (c *Client) SetHAReplica(ctx context.Context, projectID ProjectID, serviceID ServiceID, body SetHAReplicaJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SetHAReplica Change HA configuration for a Service

Changes the HA configuration for a specific service. This is an asynchronous operation.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/setHA (the `SetHAReplica` operationId).

func (*Client) SetHAReplicaWithBody 

func (c *Client) SetHAReplicaWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SetHAReplicaWithBody Change HA configuration for a Service

Changes the HA configuration for a specific service. This is an asynchronous operation.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/setHA (the `SetHAReplica` operationId).

func (*Client) SetReplicaEnvironment 

func (c *Client) SetReplicaEnvironment(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, body SetReplicaEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SetReplicaEnvironment Set Environment for a Read Replica

Sets the environment type for the read replica set.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/setEnvironment (the `SetReplicaEnvironment` operationId).

func (*Client) SetReplicaEnvironmentWithBody 

func (c *Client) SetReplicaEnvironmentWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SetReplicaEnvironmentWithBody Set Environment for a Read Replica

Sets the environment type for the read replica set.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/setEnvironment (the `SetReplicaEnvironment` operationId).

func (*Client) StartService 

func (c *Client) StartService(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

StartService Start a Service

Starts a stopped service within a project. This is an asynchronous operation.

Corresponds with POST /projects/{project_id}/services/{service_id}/start (the `StartService` operationId).

func (*Client) StopService 

func (c *Client) StopService(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

StopService Stop a Service

Stops a running service within a project. This is an asynchronous operation.

Corresponds with POST /projects/{project_id}/services/{service_id}/stop (the `StopService` operationId).

func (*Client) TrackEvent 

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

TrackEvent Track an analytics event

Tracks an analytics event with optional properties.

Takes a body of the `application/json` content type.

Corresponds with POST /analytics/track (the `TrackEvent` operationId).

func (*Client) TrackEventWithBody 

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

TrackEventWithBody Track an analytics event

Tracks an analytics event with optional properties.

Takes any type of body and a specified content type.

Corresponds with POST /analytics/track (the `TrackEvent` operationId).

func (*Client) UpdatePassword 

func (c *Client) UpdatePassword(ctx context.Context, projectID ProjectID, serviceID ServiceID, body UpdatePasswordJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdatePassword Update Service Password

Sets a new master password for the service within a project.

Takes a body of the `application/json` content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/updatePassword (the `UpdatePassword` operationId).

func (*Client) UpdatePasswordWithBody 

func (c *Client) UpdatePasswordWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdatePasswordWithBody Update Service Password

Sets a new master password for the service within a project.

Takes any type of body and a specified content type.

Corresponds with POST /projects/{project_id}/services/{service_id}/updatePassword (the `UpdatePassword` operationId).

type ClientError 

type ClientError = Error

ClientError An error returned when a request cannot be completed.

type ClientInterface 

type ClientInterface interface {

	// IdentifyUserWithBody Identify a user
	//
	// Identifies a user with optional properties for analytics tracking.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /analytics/identify (the `IdentifyUser` operationId).
	IdentifyUserWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// IdentifyUser Identify a user
	//
	// Identifies a user with optional properties for analytics tracking.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /analytics/identify (the `IdentifyUser` operationId).
	IdentifyUser(ctx context.Context, body IdentifyUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TrackEventWithBody Track an analytics event
	//
	// Tracks an analytics event with optional properties.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /analytics/track (the `TrackEvent` operationId).
	TrackEventWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TrackEvent Track an analytics event
	//
	// Tracks an analytics event with optional properties.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /analytics/track (the `TrackEvent` operationId).
	TrackEvent(ctx context.Context, body TrackEventJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAuthInfo Get Authentication Info
	//
	// Returns the authenticated caller's identity. The response shape depends on the credential type: `apiKey` for PAT
	// callers, `oauth` for OAuth user callers. Exactly one of `api_key` or `oauth` is populated;
	// `type` discriminates.
	//
	// Corresponds with GET /auth/info (the `GetAuthInfo` operationId).
	GetAuthInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LogoutWithBody Log out and revoke refresh token
	//
	// Revokes the caller's refresh token server-side. For OAuth Bearer
	// callers, include the refresh token in the request body — it is held
	// client-side and cannot be derived from the access token. Callers
	// without a refresh token to revoke may post an
	// empty body to clear server-side session state best-effort.
	//
	// Returns 204 No Content on success. The caller is still responsible
	// for dropping any locally-cached credentials.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /auth/logout (the `Logout` operationId).
	LogoutWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Logout Log out and revoke refresh token
	//
	// Revokes the caller's refresh token server-side. For OAuth Bearer
	// callers, include the refresh token in the request body — it is held
	// client-side and cannot be derived from the access token. Callers
	// without a refresh token to revoke may post an
	// empty body to clear server-side session state best-effort.
	//
	// Returns 204 No Content on success. The caller is still responsible
	// for dropping any locally-cached credentials.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /auth/logout (the `Logout` operationId).
	Logout(ctx context.Context, body LogoutJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetProjects List projects accessible to the authenticated caller
	//
	// Returns the projects the caller can access. PAT callers see only the
	// project their PAT is scoped to; OAuth user callers see all projects
	// they belong to.
	//
	// Corresponds with GET /projects (the `GetProjects` operationId).
	GetProjects(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetServices List All Services
	//
	// Retrieves a list of all services within a specific project.
	//
	// Corresponds with GET /projects/{project_id}/services (the `GetServices` operationId).
	GetServices(ctx context.Context, projectID ProjectID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateServiceWithBody Create a Service
	//
	// Creates a new database service within a project. This is an asynchronous operation.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/services (the `CreateService` operationId).
	CreateServiceWithBody(ctx context.Context, projectID ProjectID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateService Create a Service
	//
	// Creates a new database service within a project. This is an asynchronous operation.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/services (the `CreateService` operationId).
	CreateService(ctx context.Context, projectID ProjectID, body CreateServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteService Delete a Service
	//
	// Deletes a specific service. This is an asynchronous operation.
	//
	// Corresponds with DELETE /projects/{project_id}/services/{service_id} (the `DeleteService` operationId).
	DeleteService(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetService Get a Service
	//
	// Retrieves the details of a specific service by its ID.
	//
	// Corresponds with GET /projects/{project_id}/services/{service_id} (the `GetService` operationId).
	GetService(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AttachServiceToVPCWithBody Attach Service to VPC
	//
	// Associates a service with a VPC.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/attachToVPC (the `AttachServiceToVPC` operationId).
	AttachServiceToVPCWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AttachServiceToVPC Attach Service to VPC
	//
	// Associates a service with a VPC.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/attachToVPC (the `AttachServiceToVPC` operationId).
	AttachServiceToVPC(ctx context.Context, projectID ProjectID, serviceID ServiceID, body AttachServiceToVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBackups List All Backups
	//
	// **Preview - this endpoint is experimental and may change without notice.**
	//
	// Retrieves a list of the full and incremental backups taken for a
	// service. Backups run automatically on a schedule; there is no operation
	// to create or delete one. To restore data, create a recovery fork with
	// `fork_strategy: PITR`.
	//
	// Corresponds with GET /projects/{project_id}/services/{service_id}/backups (the `GetBackups` operationId).
	GetBackups(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DetachServiceFromVPCWithBody Detach Service from VPC
	//
	// Disassociates a service from its VPC.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/detachFromVPC (the `DetachServiceFromVPC` operationId).
	DetachServiceFromVPCWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DetachServiceFromVPC Detach Service from VPC
	//
	// Disassociates a service from its VPC.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/detachFromVPC (the `DetachServiceFromVPC` operationId).
	DetachServiceFromVPC(ctx context.Context, projectID ProjectID, serviceID ServiceID, body DetachServiceFromVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DisablePooler Disable Connection Pooler for a Service
	//
	// Deactivates the connection pooler for a specific service within a project.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/disablePooler (the `DisablePooler` operationId).
	DisablePooler(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EnablePooler Enable Connection Pooler for a Service
	//
	// Activates the connection pooler for a specific service within a project.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/enablePooler (the `EnablePooler` operationId).
	EnablePooler(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ForkServiceWithBody Fork a Service
	//
	// Creates a new, independent service within a project by taking a snapshot of an existing one.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/forkService (the `ForkService` operationId).
	ForkServiceWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ForkService Fork a Service
	//
	// Creates a new, independent service within a project by taking a snapshot of an existing one.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/forkService (the `ForkService` operationId).
	ForkService(ctx context.Context, projectID ProjectID, serviceID ServiceID, body ForkServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetServiceLogs Get service logs
	//
	// Fetch logs for a specific service. Returns up to 500 log entries in reverse
	// chronological order. Supports cursor-based pagination via the `cursor` parameter
	// and the `last_cursor` field in the response.
	//
	// Use the returned `last_cursor` value as the `cursor` parameter on subsequent
	// requests to page through all available logs.
	//
	// Corresponds with GET /projects/{project_id}/services/{service_id}/logs (the `GetServiceLogs` operationId).
	GetServiceLogs(ctx context.Context, projectID ProjectID, serviceID ServiceID, params *GetServiceLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetServiceMetricsAvailableSeries List available metric series
	//
	// **Preview — this endpoint is experimental and may change without notice.**
	//
	// Returns the names of all metric series available for a service.
	//
	// Corresponds with GET /projects/{project_id}/services/{service_id}/metrics/available-series (the `GetServiceMetricsAvailableSeries` operationId).
	GetServiceMetricsAvailableSeries(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetServiceMetricsSeriesWithBody Get a metric series
	//
	// **Preview — this endpoint is experimental and may change without notice.**
	//
	// Returns time-series data points for a named metric within a time window.
	// Use getServiceMetricsAvailableSeries to discover valid metric names.
	//
	// Parameters are sent as a JSON body so callers can pass an unbounded
	// filter set without query-string length pressure. The response is a list
	// of MetricSeries, each carrying its label set as a structured map
	// alongside its per-bucket data points.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/metrics/series (the `GetServiceMetricsSeries` operationId).
	GetServiceMetricsSeriesWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetServiceMetricsSeries Get a metric series
	//
	// **Preview — this endpoint is experimental and may change without notice.**
	//
	// Returns time-series data points for a named metric within a time window.
	// Use getServiceMetricsAvailableSeries to discover valid metric names.
	//
	// Parameters are sent as a JSON body so callers can pass an unbounded
	// filter set without query-string length pressure. The response is a list
	// of MetricSeries, each carrying its label set as a structured map
	// alongside its per-bucket data points.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/metrics/series (the `GetServiceMetricsSeries` operationId).
	GetServiceMetricsSeries(ctx context.Context, projectID ProjectID, serviceID ServiceID, body GetServiceMetricsSeriesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RenameServiceWithBody Rename a Service
	//
	// Updates the name of a specific service.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/rename (the `RenameService` operationId).
	RenameServiceWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RenameService Rename a Service
	//
	// Updates the name of a specific service.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/rename (the `RenameService` operationId).
	RenameService(ctx context.Context, projectID ProjectID, serviceID ServiceID, body RenameServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetReplicaSets Get Read Replica Sets
	//
	// Retrieves a list of all read replica sets associated with a primary service within a project.
	//
	// Corresponds with GET /projects/{project_id}/services/{service_id}/replicaSets (the `GetReplicaSets` operationId).
	GetReplicaSets(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateReplicaSetWithBody Create a Read Replica Set
	//
	// Creates a new read replica set for a service. This is an asynchronous operation.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets (the `CreateReplicaSet` operationId).
	CreateReplicaSetWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateReplicaSet Create a Read Replica Set
	//
	// Creates a new read replica set for a service. This is an asynchronous operation.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets (the `CreateReplicaSet` operationId).
	CreateReplicaSet(ctx context.Context, projectID ProjectID, serviceID ServiceID, body CreateReplicaSetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteReplicaSet Delete a Read Replica Set
	//
	// Deletes a specific read replica set. This is an asynchronous operation.
	//
	// Corresponds with DELETE /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id} (the `DeleteReplicaSet` operationId).
	DeleteReplicaSet(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DisableReplicaPooler Disable Connection Pooler for a Read Replica
	//
	// Deactivates the connection pooler for a specific read replica set.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/disablePooler (the `DisableReplicaPooler` operationId).
	DisableReplicaPooler(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// EnableReplicaPooler Enable Connection Pooler for a Read Replica
	//
	// Activates the connection pooler for a specific read replica set.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/enablePooler (the `EnableReplicaPooler` operationId).
	EnableReplicaPooler(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ResizeReplicaSetWithBody Resize a Read Replica Set
	//
	// Changes the resource allocation for a specific read replica set.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/resize (the `ResizeReplicaSet` operationId).
	ResizeReplicaSetWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ResizeReplicaSet Resize a Read Replica Set
	//
	// Changes the resource allocation for a specific read replica set.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/resize (the `ResizeReplicaSet` operationId).
	ResizeReplicaSet(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, body ResizeReplicaSetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetReplicaEnvironmentWithBody Set Environment for a Read Replica
	//
	// Sets the environment type for the read replica set.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/setEnvironment (the `SetReplicaEnvironment` operationId).
	SetReplicaEnvironmentWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetReplicaEnvironment Set Environment for a Read Replica
	//
	// Sets the environment type for the read replica set.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/setEnvironment (the `SetReplicaEnvironment` operationId).
	SetReplicaEnvironment(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, body SetReplicaEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ResizeServiceWithBody Resize a Service
	//
	// Changes the CPU and memory allocation for a specific service within a project. This is an asynchronous operation.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/resize (the `ResizeService` operationId).
	ResizeServiceWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ResizeService Resize a Service
	//
	// Changes the CPU and memory allocation for a specific service within a project. This is an asynchronous operation.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/resize (the `ResizeService` operationId).
	ResizeService(ctx context.Context, projectID ProjectID, serviceID ServiceID, body ResizeServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetEnvironmentWithBody Set Environment for a Service
	//
	// Sets the environment type for the service.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/setEnvironment (the `SetEnvironment` operationId).
	SetEnvironmentWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetEnvironment Set Environment for a Service
	//
	// Sets the environment type for the service.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/setEnvironment (the `SetEnvironment` operationId).
	SetEnvironment(ctx context.Context, projectID ProjectID, serviceID ServiceID, body SetEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetHAReplicaWithBody Change HA configuration for a Service
	//
	// Changes the HA configuration for a specific service. This is an asynchronous operation.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/setHA (the `SetHAReplica` operationId).
	SetHAReplicaWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetHAReplica Change HA configuration for a Service
	//
	// Changes the HA configuration for a specific service. This is an asynchronous operation.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/setHA (the `SetHAReplica` operationId).
	SetHAReplica(ctx context.Context, projectID ProjectID, serviceID ServiceID, body SetHAReplicaJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// StartService Start a Service
	//
	// Starts a stopped service within a project. This is an asynchronous operation.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/start (the `StartService` operationId).
	StartService(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// StopService Stop a Service
	//
	// Stops a running service within a project. This is an asynchronous operation.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/stop (the `StopService` operationId).
	StopService(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdatePasswordWithBody Update Service Password
	//
	// Sets a new master password for the service within a project.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/updatePassword (the `UpdatePassword` operationId).
	UpdatePasswordWithBody(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdatePassword Update Service Password
	//
	// Sets a new master password for the service within a project.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/updatePassword (the `UpdatePassword` operationId).
	UpdatePassword(ctx context.Context, projectID ProjectID, serviceID ServiceID, body UpdatePasswordJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVPCs List All VPCs
	//
	// Retrieves a list of all Virtual Private Clouds (VPCs).
	//
	// Corresponds with GET /projects/{project_id}/vpcs (the `GetVPCs` operationId).
	GetVPCs(ctx context.Context, projectID ProjectID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateVPCWithBody Create a VPC
	//
	// Creates a new Virtual Private Cloud (VPC).
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/vpcs (the `CreateVPC` operationId).
	CreateVPCWithBody(ctx context.Context, projectID ProjectID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateVPC Create a VPC
	//
	// Creates a new Virtual Private Cloud (VPC).
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/vpcs (the `CreateVPC` operationId).
	CreateVPC(ctx context.Context, projectID ProjectID, body CreateVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteVPC Delete a VPC
	//
	// Deletes a specific VPC.
	//
	// Corresponds with DELETE /projects/{project_id}/vpcs/{vpc_id} (the `DeleteVPC` operationId).
	DeleteVPC(ctx context.Context, projectID ProjectID, vpcID VPCId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVPC Get a VPC
	//
	// Retrieves the details of a specific VPC by its ID.
	//
	// Corresponds with GET /projects/{project_id}/vpcs/{vpc_id} (the `GetVPC` operationId).
	GetVPC(ctx context.Context, projectID ProjectID, vpcID VPCId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVPCPeerings List VPC Peerings
	//
	// Retrieves a list of all VPC peering connections for a given VPC.
	//
	// Corresponds with GET /projects/{project_id}/vpcs/{vpc_id}/peerings (the `GetVPCPeerings` operationId).
	GetVPCPeerings(ctx context.Context, projectID ProjectID, vpcID VPCId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateVPCPeeringWithBody Create a VPC Peering
	//
	// Creates a new VPC peering connection.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/peerings (the `CreateVPCPeering` operationId).
	CreateVPCPeeringWithBody(ctx context.Context, projectID ProjectID, vpcID VPCId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateVPCPeering Create a VPC Peering
	//
	// Creates a new VPC peering connection.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/peerings (the `CreateVPCPeering` operationId).
	CreateVPCPeering(ctx context.Context, projectID ProjectID, vpcID VPCId, body CreateVPCPeeringJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteVPCPeering Delete a VPC Peering
	//
	// Deletes a specific VPC peering connection.
	//
	// Corresponds with DELETE /projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id} (the `DeleteVPCPeering` operationId).
	DeleteVPCPeering(ctx context.Context, projectID ProjectID, vpcID VPCId, peeringID PeeringID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVPCPeering Get a VPC Peering
	//
	// Retrieves the details of a specific VPC peering connection.
	//
	// Corresponds with GET /projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id} (the `GetVPCPeering` operationId).
	GetVPCPeering(ctx context.Context, projectID ProjectID, vpcID VPCId, peeringID PeeringID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RenameVPCWithBody Rename a VPC
	//
	// Updates the name of a specific VPC.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/rename (the `RenameVPC` operationId).
	RenameVPCWithBody(ctx context.Context, projectID ProjectID, vpcID VPCId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RenameVPC Rename a VPC
	//
	// Updates the name of a specific VPC.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/rename (the `RenameVPC` operationId).
	RenameVPC(ctx context.Context, projectID ProjectID, vpcID VPCId, body RenameVPCJSONRequestBody, 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 NewTigerClient 

func NewTigerClient(cfg *config.Config, apiKey string) (*ClientWithResponses, error)

apiKey must be in "publicKey:secretKey" format.

func NewTigerClientForCredentials 

func NewTigerClientForCredentials(cfg *config.Config, creds *config.Credentials) (*ClientWithResponses, error)

NewTigerClientForCredentials dispatches on credential shape. For OAuth, rotated tokens are persisted back to storage automatically.

func NewTigerClientWithToken 

func NewTigerClientWithToken(cfg *config.Config, token *oauth2.Token, persist func(*oauth2.Token) error) (*ClientWithResponses, error)

NewTigerClientWithToken builds a Bearer-authenticated client that auto-refreshes via the gateway's /idp/external/cli/token endpoint. Rotated tokens are handed to persist (typically a keyring write); pass nil for short-lived callers that don't need to update storage (e.g. logout).

func (*ClientWithResponses) AttachServiceToVPCWithBodyWithResponse 

func (c *ClientWithResponses) AttachServiceToVPCWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachServiceToVPCResponse, error)

AttachServiceToVPCWithBodyWithResponse Attach Service to VPC

Associates a service with a VPC.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/attachToVPC (the `AttachServiceToVPC` operationId).

func (*ClientWithResponses) AttachServiceToVPCWithResponse 

func (c *ClientWithResponses) AttachServiceToVPCWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body AttachServiceToVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachServiceToVPCResponse, error)

AttachServiceToVPCWithResponse Attach Service to VPC

Associates a service with a VPC.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/attachToVPC (the `AttachServiceToVPC` operationId).

func (*ClientWithResponses) CreateReplicaSetWithBodyWithResponse 

func (c *ClientWithResponses) CreateReplicaSetWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateReplicaSetResponse, error)

CreateReplicaSetWithBodyWithResponse Create a Read Replica Set

Creates a new read replica set for a service. This is an asynchronous operation.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets (the `CreateReplicaSet` operationId).

func (*ClientWithResponses) CreateReplicaSetWithResponse 

func (c *ClientWithResponses) CreateReplicaSetWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body CreateReplicaSetJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateReplicaSetResponse, error)

CreateReplicaSetWithResponse Create a Read Replica Set

Creates a new read replica set for a service. This is an asynchronous operation.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets (the `CreateReplicaSet` operationId).

func (*ClientWithResponses) CreateServiceWithBodyWithResponse 

func (c *ClientWithResponses) CreateServiceWithBodyWithResponse(ctx context.Context, projectID ProjectID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateServiceResponse, error)

CreateServiceWithBodyWithResponse Create a Service

Creates a new database service within a project. This is an asynchronous operation.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services (the `CreateService` operationId).

func (*ClientWithResponses) CreateServiceWithResponse 

func (c *ClientWithResponses) CreateServiceWithResponse(ctx context.Context, projectID ProjectID, body CreateServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateServiceResponse, error)

CreateServiceWithResponse Create a Service

Creates a new database service within a project. This is an asynchronous operation.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services (the `CreateService` operationId).

func (*ClientWithResponses) CreateVPCPeeringWithBodyWithResponse 

func (c *ClientWithResponses) CreateVPCPeeringWithBodyWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVPCPeeringResponse, error)

CreateVPCPeeringWithBodyWithResponse Create a VPC Peering

Creates a new VPC peering connection.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/peerings (the `CreateVPCPeering` operationId).

func (*ClientWithResponses) CreateVPCPeeringWithResponse 

func (c *ClientWithResponses) CreateVPCPeeringWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, body CreateVPCPeeringJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVPCPeeringResponse, error)

CreateVPCPeeringWithResponse Create a VPC Peering

Creates a new VPC peering connection.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/peerings (the `CreateVPCPeering` operationId).

func (*ClientWithResponses) CreateVPCWithBodyWithResponse 

func (c *ClientWithResponses) CreateVPCWithBodyWithResponse(ctx context.Context, projectID ProjectID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVPCResponse, error)

CreateVPCWithBodyWithResponse Create a VPC

Creates a new Virtual Private Cloud (VPC).

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/vpcs (the `CreateVPC` operationId).

func (*ClientWithResponses) CreateVPCWithResponse 

func (c *ClientWithResponses) CreateVPCWithResponse(ctx context.Context, projectID ProjectID, body CreateVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVPCResponse, error)

CreateVPCWithResponse Create a VPC

Creates a new Virtual Private Cloud (VPC).

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/vpcs (the `CreateVPC` operationId).

func (*ClientWithResponses) DeleteReplicaSetWithResponse 

func (c *ClientWithResponses) DeleteReplicaSetWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, reqEditors ...RequestEditorFn) (*DeleteReplicaSetResponse, error)

DeleteReplicaSetWithResponse Delete a Read Replica Set

Deletes a specific read replica set. This is an asynchronous operation.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id} (the `DeleteReplicaSet` operationId).

func (*ClientWithResponses) DeleteServiceWithResponse 

func (c *ClientWithResponses) DeleteServiceWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*DeleteServiceResponse, error)

DeleteServiceWithResponse Delete a Service

Deletes a specific service. This is an asynchronous operation.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /projects/{project_id}/services/{service_id} (the `DeleteService` operationId).

func (*ClientWithResponses) DeleteVPCPeeringWithResponse 

func (c *ClientWithResponses) DeleteVPCPeeringWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, peeringID PeeringID, reqEditors ...RequestEditorFn) (*DeleteVPCPeeringResponse, error)

DeleteVPCPeeringWithResponse Delete a VPC Peering

Deletes a specific VPC peering connection.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id} (the `DeleteVPCPeering` operationId).

func (*ClientWithResponses) DeleteVPCWithResponse 

func (c *ClientWithResponses) DeleteVPCWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, reqEditors ...RequestEditorFn) (*DeleteVPCResponse, error)

DeleteVPCWithResponse Delete a VPC

Deletes a specific VPC.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /projects/{project_id}/vpcs/{vpc_id} (the `DeleteVPC` operationId).

func (*ClientWithResponses) DetachServiceFromVPCWithBodyWithResponse 

func (c *ClientWithResponses) DetachServiceFromVPCWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DetachServiceFromVPCResponse, error)

DetachServiceFromVPCWithBodyWithResponse Detach Service from VPC

Disassociates a service from its VPC.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/detachFromVPC (the `DetachServiceFromVPC` operationId).

func (*ClientWithResponses) DetachServiceFromVPCWithResponse 

func (c *ClientWithResponses) DetachServiceFromVPCWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body DetachServiceFromVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*DetachServiceFromVPCResponse, error)

DetachServiceFromVPCWithResponse Detach Service from VPC

Disassociates a service from its VPC.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/detachFromVPC (the `DetachServiceFromVPC` operationId).

func (*ClientWithResponses) DisablePoolerWithResponse 

func (c *ClientWithResponses) DisablePoolerWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*DisablePoolerResponse, error)

DisablePoolerWithResponse Disable Connection Pooler for a Service

Deactivates the connection pooler for a specific service within a project.

Returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/disablePooler (the `DisablePooler` operationId).

func (*ClientWithResponses) DisableReplicaPoolerWithResponse 

func (c *ClientWithResponses) DisableReplicaPoolerWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, reqEditors ...RequestEditorFn) (*DisableReplicaPoolerResponse, error)

DisableReplicaPoolerWithResponse Disable Connection Pooler for a Read Replica

Deactivates the connection pooler for a specific read replica set.

Returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/disablePooler (the `DisableReplicaPooler` operationId).

func (*ClientWithResponses) EnablePoolerWithResponse 

func (c *ClientWithResponses) EnablePoolerWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*EnablePoolerResponse, error)

EnablePoolerWithResponse Enable Connection Pooler for a Service

Activates the connection pooler for a specific service within a project.

Returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/enablePooler (the `EnablePooler` operationId).

func (*ClientWithResponses) EnableReplicaPoolerWithResponse 

func (c *ClientWithResponses) EnableReplicaPoolerWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, reqEditors ...RequestEditorFn) (*EnableReplicaPoolerResponse, error)

EnableReplicaPoolerWithResponse Enable Connection Pooler for a Read Replica

Activates the connection pooler for a specific read replica set.

Returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/enablePooler (the `EnableReplicaPooler` operationId).

func (*ClientWithResponses) ForkServiceWithBodyWithResponse 

func (c *ClientWithResponses) ForkServiceWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ForkServiceResponse, error)

ForkServiceWithBodyWithResponse Fork a Service

Creates a new, independent service within a project by taking a snapshot of an existing one.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/forkService (the `ForkService` operationId).

func (*ClientWithResponses) ForkServiceWithResponse 

func (c *ClientWithResponses) ForkServiceWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body ForkServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*ForkServiceResponse, error)

ForkServiceWithResponse Fork a Service

Creates a new, independent service within a project by taking a snapshot of an existing one.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/forkService (the `ForkService` operationId).

func (*ClientWithResponses) GetAuthInfoWithResponse 

func (c *ClientWithResponses) GetAuthInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAuthInfoResponse, error)

GetAuthInfoWithResponse Get Authentication Info

Returns the authenticated caller's identity. The response shape depends on the credential type: `apiKey` for PAT callers, `oauth` for OAuth user callers. Exactly one of `api_key` or `oauth` is populated; `type` discriminates.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /auth/info (the `GetAuthInfo` operationId).

func (*ClientWithResponses) GetBackupsWithResponse added in v0.23.0 

func (c *ClientWithResponses) GetBackupsWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*GetBackupsResponse, error)

GetBackupsWithResponse List All Backups

**Preview - this endpoint is experimental and may change without notice.**

Retrieves a list of the full and incremental backups taken for a service. Backups run automatically on a schedule; there is no operation to create or delete one. To restore data, create a recovery fork with `fork_strategy: PITR`.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /projects/{project_id}/services/{service_id}/backups (the `GetBackups` operationId).

func (*ClientWithResponses) GetProjectsWithResponse 

func (c *ClientWithResponses) GetProjectsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetProjectsResponse, error)

GetProjectsWithResponse List projects accessible to the authenticated caller

Returns the projects the caller can access. PAT callers see only the project their PAT is scoped to; OAuth user callers see all projects they belong to.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /projects (the `GetProjects` operationId).

func (*ClientWithResponses) GetReplicaSetsWithResponse 

func (c *ClientWithResponses) GetReplicaSetsWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*GetReplicaSetsResponse, error)

GetReplicaSetsWithResponse Get Read Replica Sets

Retrieves a list of all read replica sets associated with a primary service within a project.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /projects/{project_id}/services/{service_id}/replicaSets (the `GetReplicaSets` operationId).

func (*ClientWithResponses) GetServiceLogsWithResponse 

func (c *ClientWithResponses) GetServiceLogsWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, params *GetServiceLogsParams, reqEditors ...RequestEditorFn) (*GetServiceLogsResponse, error)

GetServiceLogsWithResponse Get service logs

Fetch logs for a specific service. Returns up to 500 log entries in reverse chronological order. Supports cursor-based pagination via the `cursor` parameter and the `last_cursor` field in the response.

Use the returned `last_cursor` value as the `cursor` parameter on subsequent requests to page through all available logs.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /projects/{project_id}/services/{service_id}/logs (the `GetServiceLogs` operationId).

func (*ClientWithResponses) GetServiceMetricsAvailableSeriesWithResponse 

func (c *ClientWithResponses) GetServiceMetricsAvailableSeriesWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*GetServiceMetricsAvailableSeriesResponse, error)

GetServiceMetricsAvailableSeriesWithResponse List available metric series

**Preview — this endpoint is experimental and may change without notice.**

Returns the names of all metric series available for a service.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /projects/{project_id}/services/{service_id}/metrics/available-series (the `GetServiceMetricsAvailableSeries` operationId).

func (*ClientWithResponses) GetServiceMetricsSeriesWithBodyWithResponse 

func (c *ClientWithResponses) GetServiceMetricsSeriesWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetServiceMetricsSeriesResponse, error)

GetServiceMetricsSeriesWithBodyWithResponse Get a metric series

**Preview — this endpoint is experimental and may change without notice.**

Returns time-series data points for a named metric within a time window. Use getServiceMetricsAvailableSeries to discover valid metric names.

Parameters are sent as a JSON body so callers can pass an unbounded filter set without query-string length pressure. The response is a list of MetricSeries, each carrying its label set as a structured map alongside its per-bucket data points.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/metrics/series (the `GetServiceMetricsSeries` operationId).

func (*ClientWithResponses) GetServiceMetricsSeriesWithResponse 

func (c *ClientWithResponses) GetServiceMetricsSeriesWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body GetServiceMetricsSeriesJSONRequestBody, reqEditors ...RequestEditorFn) (*GetServiceMetricsSeriesResponse, error)

GetServiceMetricsSeriesWithResponse Get a metric series

**Preview — this endpoint is experimental and may change without notice.**

Returns time-series data points for a named metric within a time window. Use getServiceMetricsAvailableSeries to discover valid metric names.

Parameters are sent as a JSON body so callers can pass an unbounded filter set without query-string length pressure. The response is a list of MetricSeries, each carrying its label set as a structured map alongside its per-bucket data points.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/metrics/series (the `GetServiceMetricsSeries` operationId).

func (*ClientWithResponses) GetServiceWithResponse 

func (c *ClientWithResponses) GetServiceWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*GetServiceResponse, error)

GetServiceWithResponse Get a Service

Retrieves the details of a specific service by its ID.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /projects/{project_id}/services/{service_id} (the `GetService` operationId).

func (*ClientWithResponses) GetServicesWithResponse 

func (c *ClientWithResponses) GetServicesWithResponse(ctx context.Context, projectID ProjectID, reqEditors ...RequestEditorFn) (*GetServicesResponse, error)

GetServicesWithResponse List All Services

Retrieves a list of all services within a specific project.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /projects/{project_id}/services (the `GetServices` operationId).

func (*ClientWithResponses) GetVPCPeeringWithResponse 

func (c *ClientWithResponses) GetVPCPeeringWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, peeringID PeeringID, reqEditors ...RequestEditorFn) (*GetVPCPeeringResponse, error)

GetVPCPeeringWithResponse Get a VPC Peering

Retrieves the details of a specific VPC peering connection.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id} (the `GetVPCPeering` operationId).

func (*ClientWithResponses) GetVPCPeeringsWithResponse 

func (c *ClientWithResponses) GetVPCPeeringsWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, reqEditors ...RequestEditorFn) (*GetVPCPeeringsResponse, error)

GetVPCPeeringsWithResponse List VPC Peerings

Retrieves a list of all VPC peering connections for a given VPC.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /projects/{project_id}/vpcs/{vpc_id}/peerings (the `GetVPCPeerings` operationId).

func (*ClientWithResponses) GetVPCWithResponse 

func (c *ClientWithResponses) GetVPCWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, reqEditors ...RequestEditorFn) (*GetVPCResponse, error)

GetVPCWithResponse Get a VPC

Retrieves the details of a specific VPC by its ID.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /projects/{project_id}/vpcs/{vpc_id} (the `GetVPC` operationId).

func (*ClientWithResponses) GetVPCsWithResponse 

func (c *ClientWithResponses) GetVPCsWithResponse(ctx context.Context, projectID ProjectID, reqEditors ...RequestEditorFn) (*GetVPCsResponse, error)

GetVPCsWithResponse List All VPCs

Retrieves a list of all Virtual Private Clouds (VPCs).

Returns a wrapper object for the known response body format(s).

Corresponds with GET /projects/{project_id}/vpcs (the `GetVPCs` operationId).

func (*ClientWithResponses) IdentifyUserWithBodyWithResponse 

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

IdentifyUserWithBodyWithResponse Identify a user

Identifies a user with optional properties for analytics tracking.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /analytics/identify (the `IdentifyUser` operationId).

func (*ClientWithResponses) IdentifyUserWithResponse 

func (c *ClientWithResponses) IdentifyUserWithResponse(ctx context.Context, body IdentifyUserJSONRequestBody, reqEditors ...RequestEditorFn) (*IdentifyUserResponse, error)

IdentifyUserWithResponse Identify a user

Identifies a user with optional properties for analytics tracking.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /analytics/identify (the `IdentifyUser` operationId).

func (*ClientWithResponses) LogoutWithBodyWithResponse 

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

LogoutWithBodyWithResponse Log out and revoke refresh token

Revokes the caller's refresh token server-side. For OAuth Bearer callers, include the refresh token in the request body — it is held client-side and cannot be derived from the access token. Callers without a refresh token to revoke may post an empty body to clear server-side session state best-effort.

Returns 204 No Content on success. The caller is still responsible for dropping any locally-cached credentials.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /auth/logout (the `Logout` operationId).

func (*ClientWithResponses) LogoutWithResponse 

func (c *ClientWithResponses) LogoutWithResponse(ctx context.Context, body LogoutJSONRequestBody, reqEditors ...RequestEditorFn) (*LogoutResponse, error)

LogoutWithResponse Log out and revoke refresh token

Revokes the caller's refresh token server-side. For OAuth Bearer callers, include the refresh token in the request body — it is held client-side and cannot be derived from the access token. Callers without a refresh token to revoke may post an empty body to clear server-side session state best-effort.

Returns 204 No Content on success. The caller is still responsible for dropping any locally-cached credentials.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /auth/logout (the `Logout` operationId).

func (*ClientWithResponses) RenameServiceWithBodyWithResponse 

func (c *ClientWithResponses) RenameServiceWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RenameServiceResponse, error)

RenameServiceWithBodyWithResponse Rename a Service

Updates the name of a specific service.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/rename (the `RenameService` operationId).

func (*ClientWithResponses) RenameServiceWithResponse 

func (c *ClientWithResponses) RenameServiceWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body RenameServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*RenameServiceResponse, error)

RenameServiceWithResponse Rename a Service

Updates the name of a specific service.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/rename (the `RenameService` operationId).

func (*ClientWithResponses) RenameVPCWithBodyWithResponse 

func (c *ClientWithResponses) RenameVPCWithBodyWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RenameVPCResponse, error)

RenameVPCWithBodyWithResponse Rename a VPC

Updates the name of a specific VPC.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/rename (the `RenameVPC` operationId).

func (*ClientWithResponses) RenameVPCWithResponse 

func (c *ClientWithResponses) RenameVPCWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, body RenameVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*RenameVPCResponse, error)

RenameVPCWithResponse Rename a VPC

Updates the name of a specific VPC.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/rename (the `RenameVPC` operationId).

func (*ClientWithResponses) ResizeReplicaSetWithBodyWithResponse 

func (c *ClientWithResponses) ResizeReplicaSetWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResizeReplicaSetResponse, error)

ResizeReplicaSetWithBodyWithResponse Resize a Read Replica Set

Changes the resource allocation for a specific read replica set.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/resize (the `ResizeReplicaSet` operationId).

func (*ClientWithResponses) ResizeReplicaSetWithResponse 

func (c *ClientWithResponses) ResizeReplicaSetWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, body ResizeReplicaSetJSONRequestBody, reqEditors ...RequestEditorFn) (*ResizeReplicaSetResponse, error)

ResizeReplicaSetWithResponse Resize a Read Replica Set

Changes the resource allocation for a specific read replica set.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/resize (the `ResizeReplicaSet` operationId).

func (*ClientWithResponses) ResizeServiceWithBodyWithResponse 

func (c *ClientWithResponses) ResizeServiceWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResizeServiceResponse, error)

ResizeServiceWithBodyWithResponse Resize a Service

Changes the CPU and memory allocation for a specific service within a project. This is an asynchronous operation.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/resize (the `ResizeService` operationId).

func (*ClientWithResponses) ResizeServiceWithResponse 

func (c *ClientWithResponses) ResizeServiceWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body ResizeServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*ResizeServiceResponse, error)

ResizeServiceWithResponse Resize a Service

Changes the CPU and memory allocation for a specific service within a project. This is an asynchronous operation.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/resize (the `ResizeService` operationId).

func (*ClientWithResponses) SetEnvironmentWithBodyWithResponse 

func (c *ClientWithResponses) SetEnvironmentWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetEnvironmentResponse, error)

SetEnvironmentWithBodyWithResponse Set Environment for a Service

Sets the environment type for the service.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/setEnvironment (the `SetEnvironment` operationId).

func (*ClientWithResponses) SetEnvironmentWithResponse 

func (c *ClientWithResponses) SetEnvironmentWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body SetEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*SetEnvironmentResponse, error)

SetEnvironmentWithResponse Set Environment for a Service

Sets the environment type for the service.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/setEnvironment (the `SetEnvironment` operationId).

func (*ClientWithResponses) SetHAReplicaWithBodyWithResponse 

func (c *ClientWithResponses) SetHAReplicaWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetHAReplicaResponse, error)

SetHAReplicaWithBodyWithResponse Change HA configuration for a Service

Changes the HA configuration for a specific service. This is an asynchronous operation.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/setHA (the `SetHAReplica` operationId).

func (*ClientWithResponses) SetHAReplicaWithResponse 

func (c *ClientWithResponses) SetHAReplicaWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body SetHAReplicaJSONRequestBody, reqEditors ...RequestEditorFn) (*SetHAReplicaResponse, error)

SetHAReplicaWithResponse Change HA configuration for a Service

Changes the HA configuration for a specific service. This is an asynchronous operation.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/setHA (the `SetHAReplica` operationId).

func (*ClientWithResponses) SetReplicaEnvironmentWithBodyWithResponse 

func (c *ClientWithResponses) SetReplicaEnvironmentWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetReplicaEnvironmentResponse, error)

SetReplicaEnvironmentWithBodyWithResponse Set Environment for a Read Replica

Sets the environment type for the read replica set.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/setEnvironment (the `SetReplicaEnvironment` operationId).

func (*ClientWithResponses) SetReplicaEnvironmentWithResponse 

func (c *ClientWithResponses) SetReplicaEnvironmentWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, body SetReplicaEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*SetReplicaEnvironmentResponse, error)

SetReplicaEnvironmentWithResponse Set Environment for a Read Replica

Sets the environment type for the read replica set.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/setEnvironment (the `SetReplicaEnvironment` operationId).

func (*ClientWithResponses) StartServiceWithResponse 

func (c *ClientWithResponses) StartServiceWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*StartServiceResponse, error)

StartServiceWithResponse Start a Service

Starts a stopped service within a project. This is an asynchronous operation.

Returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/start (the `StartService` operationId).

func (*ClientWithResponses) StopServiceWithResponse 

func (c *ClientWithResponses) StopServiceWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*StopServiceResponse, error)

StopServiceWithResponse Stop a Service

Stops a running service within a project. This is an asynchronous operation.

Returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/stop (the `StopService` operationId).

func (*ClientWithResponses) TrackEventWithBodyWithResponse 

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

TrackEventWithBodyWithResponse Track an analytics event

Tracks an analytics event with optional properties.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /analytics/track (the `TrackEvent` operationId).

func (*ClientWithResponses) TrackEventWithResponse 

func (c *ClientWithResponses) TrackEventWithResponse(ctx context.Context, body TrackEventJSONRequestBody, reqEditors ...RequestEditorFn) (*TrackEventResponse, error)

TrackEventWithResponse Track an analytics event

Tracks an analytics event with optional properties.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /analytics/track (the `TrackEvent` operationId).

func (*ClientWithResponses) UpdatePasswordWithBodyWithResponse 

func (c *ClientWithResponses) UpdatePasswordWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdatePasswordResponse, error)

UpdatePasswordWithBodyWithResponse Update Service Password

Sets a new master password for the service within a project.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/updatePassword (the `UpdatePassword` operationId).

func (*ClientWithResponses) UpdatePasswordWithResponse 

func (c *ClientWithResponses) UpdatePasswordWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body UpdatePasswordJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdatePasswordResponse, error)

UpdatePasswordWithResponse Update Service Password

Sets a new master password for the service within a project.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /projects/{project_id}/services/{service_id}/updatePassword (the `UpdatePassword` operationId).

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {

	// IdentifyUserWithBodyWithResponse Identify a user
	//
	// Identifies a user with optional properties for analytics tracking.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /analytics/identify (the `IdentifyUser` operationId).
	IdentifyUserWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IdentifyUserResponse, error)

	// IdentifyUserWithResponse Identify a user
	//
	// Identifies a user with optional properties for analytics tracking.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /analytics/identify (the `IdentifyUser` operationId).
	IdentifyUserWithResponse(ctx context.Context, body IdentifyUserJSONRequestBody, reqEditors ...RequestEditorFn) (*IdentifyUserResponse, error)

	// TrackEventWithBodyWithResponse Track an analytics event
	//
	// Tracks an analytics event with optional properties.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /analytics/track (the `TrackEvent` operationId).
	TrackEventWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*TrackEventResponse, error)

	// TrackEventWithResponse Track an analytics event
	//
	// Tracks an analytics event with optional properties.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /analytics/track (the `TrackEvent` operationId).
	TrackEventWithResponse(ctx context.Context, body TrackEventJSONRequestBody, reqEditors ...RequestEditorFn) (*TrackEventResponse, error)

	// GetAuthInfoWithResponse Get Authentication Info
	//
	// Returns the authenticated caller's identity. The response shape depends on the credential type: `apiKey` for PAT
	// callers, `oauth` for OAuth user callers. Exactly one of `api_key` or `oauth` is populated;
	// `type` discriminates.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /auth/info (the `GetAuthInfo` operationId).
	GetAuthInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAuthInfoResponse, error)

	// LogoutWithBodyWithResponse Log out and revoke refresh token
	//
	// Revokes the caller's refresh token server-side. For OAuth Bearer
	// callers, include the refresh token in the request body — it is held
	// client-side and cannot be derived from the access token. Callers
	// without a refresh token to revoke may post an
	// empty body to clear server-side session state best-effort.
	//
	// Returns 204 No Content on success. The caller is still responsible
	// for dropping any locally-cached credentials.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /auth/logout (the `Logout` operationId).
	LogoutWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*LogoutResponse, error)

	// LogoutWithResponse Log out and revoke refresh token
	//
	// Revokes the caller's refresh token server-side. For OAuth Bearer
	// callers, include the refresh token in the request body — it is held
	// client-side and cannot be derived from the access token. Callers
	// without a refresh token to revoke may post an
	// empty body to clear server-side session state best-effort.
	//
	// Returns 204 No Content on success. The caller is still responsible
	// for dropping any locally-cached credentials.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /auth/logout (the `Logout` operationId).
	LogoutWithResponse(ctx context.Context, body LogoutJSONRequestBody, reqEditors ...RequestEditorFn) (*LogoutResponse, error)

	// GetProjectsWithResponse List projects accessible to the authenticated caller
	//
	// Returns the projects the caller can access. PAT callers see only the
	// project their PAT is scoped to; OAuth user callers see all projects
	// they belong to.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /projects (the `GetProjects` operationId).
	GetProjectsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetProjectsResponse, error)

	// GetServicesWithResponse List All Services
	//
	// Retrieves a list of all services within a specific project.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /projects/{project_id}/services (the `GetServices` operationId).
	GetServicesWithResponse(ctx context.Context, projectID ProjectID, reqEditors ...RequestEditorFn) (*GetServicesResponse, error)

	// CreateServiceWithBodyWithResponse Create a Service
	//
	// Creates a new database service within a project. This is an asynchronous operation.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services (the `CreateService` operationId).
	CreateServiceWithBodyWithResponse(ctx context.Context, projectID ProjectID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateServiceResponse, error)

	// CreateServiceWithResponse Create a Service
	//
	// Creates a new database service within a project. This is an asynchronous operation.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services (the `CreateService` operationId).
	CreateServiceWithResponse(ctx context.Context, projectID ProjectID, body CreateServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateServiceResponse, error)

	// DeleteServiceWithResponse Delete a Service
	//
	// Deletes a specific service. This is an asynchronous operation.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /projects/{project_id}/services/{service_id} (the `DeleteService` operationId).
	DeleteServiceWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*DeleteServiceResponse, error)

	// GetServiceWithResponse Get a Service
	//
	// Retrieves the details of a specific service by its ID.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /projects/{project_id}/services/{service_id} (the `GetService` operationId).
	GetServiceWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*GetServiceResponse, error)

	// AttachServiceToVPCWithBodyWithResponse Attach Service to VPC
	//
	// Associates a service with a VPC.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/attachToVPC (the `AttachServiceToVPC` operationId).
	AttachServiceToVPCWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AttachServiceToVPCResponse, error)

	// AttachServiceToVPCWithResponse Attach Service to VPC
	//
	// Associates a service with a VPC.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/attachToVPC (the `AttachServiceToVPC` operationId).
	AttachServiceToVPCWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body AttachServiceToVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*AttachServiceToVPCResponse, error)

	// GetBackupsWithResponse List All Backups
	//
	// **Preview - this endpoint is experimental and may change without notice.**
	//
	// Retrieves a list of the full and incremental backups taken for a
	// service. Backups run automatically on a schedule; there is no operation
	// to create or delete one. To restore data, create a recovery fork with
	// `fork_strategy: PITR`.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /projects/{project_id}/services/{service_id}/backups (the `GetBackups` operationId).
	GetBackupsWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*GetBackupsResponse, error)

	// DetachServiceFromVPCWithBodyWithResponse Detach Service from VPC
	//
	// Disassociates a service from its VPC.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/detachFromVPC (the `DetachServiceFromVPC` operationId).
	DetachServiceFromVPCWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DetachServiceFromVPCResponse, error)

	// DetachServiceFromVPCWithResponse Detach Service from VPC
	//
	// Disassociates a service from its VPC.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/detachFromVPC (the `DetachServiceFromVPC` operationId).
	DetachServiceFromVPCWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body DetachServiceFromVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*DetachServiceFromVPCResponse, error)

	// DisablePoolerWithResponse Disable Connection Pooler for a Service
	//
	// Deactivates the connection pooler for a specific service within a project.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/disablePooler (the `DisablePooler` operationId).
	DisablePoolerWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*DisablePoolerResponse, error)

	// EnablePoolerWithResponse Enable Connection Pooler for a Service
	//
	// Activates the connection pooler for a specific service within a project.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/enablePooler (the `EnablePooler` operationId).
	EnablePoolerWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*EnablePoolerResponse, error)

	// ForkServiceWithBodyWithResponse Fork a Service
	//
	// Creates a new, independent service within a project by taking a snapshot of an existing one.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/forkService (the `ForkService` operationId).
	ForkServiceWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ForkServiceResponse, error)

	// ForkServiceWithResponse Fork a Service
	//
	// Creates a new, independent service within a project by taking a snapshot of an existing one.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/forkService (the `ForkService` operationId).
	ForkServiceWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body ForkServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*ForkServiceResponse, error)

	// GetServiceLogsWithResponse Get service logs
	//
	// Fetch logs for a specific service. Returns up to 500 log entries in reverse
	// chronological order. Supports cursor-based pagination via the `cursor` parameter
	// and the `last_cursor` field in the response.
	//
	// Use the returned `last_cursor` value as the `cursor` parameter on subsequent
	// requests to page through all available logs.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /projects/{project_id}/services/{service_id}/logs (the `GetServiceLogs` operationId).
	GetServiceLogsWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, params *GetServiceLogsParams, reqEditors ...RequestEditorFn) (*GetServiceLogsResponse, error)

	// GetServiceMetricsAvailableSeriesWithResponse List available metric series
	//
	// **Preview — this endpoint is experimental and may change without notice.**
	//
	// Returns the names of all metric series available for a service.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /projects/{project_id}/services/{service_id}/metrics/available-series (the `GetServiceMetricsAvailableSeries` operationId).
	GetServiceMetricsAvailableSeriesWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*GetServiceMetricsAvailableSeriesResponse, error)

	// GetServiceMetricsSeriesWithBodyWithResponse Get a metric series
	//
	// **Preview — this endpoint is experimental and may change without notice.**
	//
	// Returns time-series data points for a named metric within a time window.
	// Use getServiceMetricsAvailableSeries to discover valid metric names.
	//
	// Parameters are sent as a JSON body so callers can pass an unbounded
	// filter set without query-string length pressure. The response is a list
	// of MetricSeries, each carrying its label set as a structured map
	// alongside its per-bucket data points.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/metrics/series (the `GetServiceMetricsSeries` operationId).
	GetServiceMetricsSeriesWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetServiceMetricsSeriesResponse, error)

	// GetServiceMetricsSeriesWithResponse Get a metric series
	//
	// **Preview — this endpoint is experimental and may change without notice.**
	//
	// Returns time-series data points for a named metric within a time window.
	// Use getServiceMetricsAvailableSeries to discover valid metric names.
	//
	// Parameters are sent as a JSON body so callers can pass an unbounded
	// filter set without query-string length pressure. The response is a list
	// of MetricSeries, each carrying its label set as a structured map
	// alongside its per-bucket data points.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/metrics/series (the `GetServiceMetricsSeries` operationId).
	GetServiceMetricsSeriesWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body GetServiceMetricsSeriesJSONRequestBody, reqEditors ...RequestEditorFn) (*GetServiceMetricsSeriesResponse, error)

	// RenameServiceWithBodyWithResponse Rename a Service
	//
	// Updates the name of a specific service.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/rename (the `RenameService` operationId).
	RenameServiceWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RenameServiceResponse, error)

	// RenameServiceWithResponse Rename a Service
	//
	// Updates the name of a specific service.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/rename (the `RenameService` operationId).
	RenameServiceWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body RenameServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*RenameServiceResponse, error)

	// GetReplicaSetsWithResponse Get Read Replica Sets
	//
	// Retrieves a list of all read replica sets associated with a primary service within a project.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /projects/{project_id}/services/{service_id}/replicaSets (the `GetReplicaSets` operationId).
	GetReplicaSetsWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*GetReplicaSetsResponse, error)

	// CreateReplicaSetWithBodyWithResponse Create a Read Replica Set
	//
	// Creates a new read replica set for a service. This is an asynchronous operation.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets (the `CreateReplicaSet` operationId).
	CreateReplicaSetWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateReplicaSetResponse, error)

	// CreateReplicaSetWithResponse Create a Read Replica Set
	//
	// Creates a new read replica set for a service. This is an asynchronous operation.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets (the `CreateReplicaSet` operationId).
	CreateReplicaSetWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body CreateReplicaSetJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateReplicaSetResponse, error)

	// DeleteReplicaSetWithResponse Delete a Read Replica Set
	//
	// Deletes a specific read replica set. This is an asynchronous operation.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id} (the `DeleteReplicaSet` operationId).
	DeleteReplicaSetWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, reqEditors ...RequestEditorFn) (*DeleteReplicaSetResponse, error)

	// DisableReplicaPoolerWithResponse Disable Connection Pooler for a Read Replica
	//
	// Deactivates the connection pooler for a specific read replica set.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/disablePooler (the `DisableReplicaPooler` operationId).
	DisableReplicaPoolerWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, reqEditors ...RequestEditorFn) (*DisableReplicaPoolerResponse, error)

	// EnableReplicaPoolerWithResponse Enable Connection Pooler for a Read Replica
	//
	// Activates the connection pooler for a specific read replica set.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/enablePooler (the `EnableReplicaPooler` operationId).
	EnableReplicaPoolerWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, reqEditors ...RequestEditorFn) (*EnableReplicaPoolerResponse, error)

	// ResizeReplicaSetWithBodyWithResponse Resize a Read Replica Set
	//
	// Changes the resource allocation for a specific read replica set.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/resize (the `ResizeReplicaSet` operationId).
	ResizeReplicaSetWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResizeReplicaSetResponse, error)

	// ResizeReplicaSetWithResponse Resize a Read Replica Set
	//
	// Changes the resource allocation for a specific read replica set.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/resize (the `ResizeReplicaSet` operationId).
	ResizeReplicaSetWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, body ResizeReplicaSetJSONRequestBody, reqEditors ...RequestEditorFn) (*ResizeReplicaSetResponse, error)

	// SetReplicaEnvironmentWithBodyWithResponse Set Environment for a Read Replica
	//
	// Sets the environment type for the read replica set.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/setEnvironment (the `SetReplicaEnvironment` operationId).
	SetReplicaEnvironmentWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetReplicaEnvironmentResponse, error)

	// SetReplicaEnvironmentWithResponse Set Environment for a Read Replica
	//
	// Sets the environment type for the read replica set.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/setEnvironment (the `SetReplicaEnvironment` operationId).
	SetReplicaEnvironmentWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, replicaSetID ReplicaSetID, body SetReplicaEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*SetReplicaEnvironmentResponse, error)

	// ResizeServiceWithBodyWithResponse Resize a Service
	//
	// Changes the CPU and memory allocation for a specific service within a project. This is an asynchronous operation.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/resize (the `ResizeService` operationId).
	ResizeServiceWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ResizeServiceResponse, error)

	// ResizeServiceWithResponse Resize a Service
	//
	// Changes the CPU and memory allocation for a specific service within a project. This is an asynchronous operation.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/resize (the `ResizeService` operationId).
	ResizeServiceWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body ResizeServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*ResizeServiceResponse, error)

	// SetEnvironmentWithBodyWithResponse Set Environment for a Service
	//
	// Sets the environment type for the service.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/setEnvironment (the `SetEnvironment` operationId).
	SetEnvironmentWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetEnvironmentResponse, error)

	// SetEnvironmentWithResponse Set Environment for a Service
	//
	// Sets the environment type for the service.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/setEnvironment (the `SetEnvironment` operationId).
	SetEnvironmentWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body SetEnvironmentJSONRequestBody, reqEditors ...RequestEditorFn) (*SetEnvironmentResponse, error)

	// SetHAReplicaWithBodyWithResponse Change HA configuration for a Service
	//
	// Changes the HA configuration for a specific service. This is an asynchronous operation.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/setHA (the `SetHAReplica` operationId).
	SetHAReplicaWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetHAReplicaResponse, error)

	// SetHAReplicaWithResponse Change HA configuration for a Service
	//
	// Changes the HA configuration for a specific service. This is an asynchronous operation.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/setHA (the `SetHAReplica` operationId).
	SetHAReplicaWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body SetHAReplicaJSONRequestBody, reqEditors ...RequestEditorFn) (*SetHAReplicaResponse, error)

	// StartServiceWithResponse Start a Service
	//
	// Starts a stopped service within a project. This is an asynchronous operation.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/start (the `StartService` operationId).
	StartServiceWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*StartServiceResponse, error)

	// StopServiceWithResponse Stop a Service
	//
	// Stops a running service within a project. This is an asynchronous operation.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/stop (the `StopService` operationId).
	StopServiceWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, reqEditors ...RequestEditorFn) (*StopServiceResponse, error)

	// UpdatePasswordWithBodyWithResponse Update Service Password
	//
	// Sets a new master password for the service within a project.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/updatePassword (the `UpdatePassword` operationId).
	UpdatePasswordWithBodyWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdatePasswordResponse, error)

	// UpdatePasswordWithResponse Update Service Password
	//
	// Sets a new master password for the service within a project.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/services/{service_id}/updatePassword (the `UpdatePassword` operationId).
	UpdatePasswordWithResponse(ctx context.Context, projectID ProjectID, serviceID ServiceID, body UpdatePasswordJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdatePasswordResponse, error)

	// GetVPCsWithResponse List All VPCs
	//
	// Retrieves a list of all Virtual Private Clouds (VPCs).
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /projects/{project_id}/vpcs (the `GetVPCs` operationId).
	GetVPCsWithResponse(ctx context.Context, projectID ProjectID, reqEditors ...RequestEditorFn) (*GetVPCsResponse, error)

	// CreateVPCWithBodyWithResponse Create a VPC
	//
	// Creates a new Virtual Private Cloud (VPC).
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/vpcs (the `CreateVPC` operationId).
	CreateVPCWithBodyWithResponse(ctx context.Context, projectID ProjectID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVPCResponse, error)

	// CreateVPCWithResponse Create a VPC
	//
	// Creates a new Virtual Private Cloud (VPC).
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/vpcs (the `CreateVPC` operationId).
	CreateVPCWithResponse(ctx context.Context, projectID ProjectID, body CreateVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVPCResponse, error)

	// DeleteVPCWithResponse Delete a VPC
	//
	// Deletes a specific VPC.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /projects/{project_id}/vpcs/{vpc_id} (the `DeleteVPC` operationId).
	DeleteVPCWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, reqEditors ...RequestEditorFn) (*DeleteVPCResponse, error)

	// GetVPCWithResponse Get a VPC
	//
	// Retrieves the details of a specific VPC by its ID.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /projects/{project_id}/vpcs/{vpc_id} (the `GetVPC` operationId).
	GetVPCWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, reqEditors ...RequestEditorFn) (*GetVPCResponse, error)

	// GetVPCPeeringsWithResponse List VPC Peerings
	//
	// Retrieves a list of all VPC peering connections for a given VPC.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /projects/{project_id}/vpcs/{vpc_id}/peerings (the `GetVPCPeerings` operationId).
	GetVPCPeeringsWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, reqEditors ...RequestEditorFn) (*GetVPCPeeringsResponse, error)

	// CreateVPCPeeringWithBodyWithResponse Create a VPC Peering
	//
	// Creates a new VPC peering connection.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/peerings (the `CreateVPCPeering` operationId).
	CreateVPCPeeringWithBodyWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVPCPeeringResponse, error)

	// CreateVPCPeeringWithResponse Create a VPC Peering
	//
	// Creates a new VPC peering connection.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/peerings (the `CreateVPCPeering` operationId).
	CreateVPCPeeringWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, body CreateVPCPeeringJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVPCPeeringResponse, error)

	// DeleteVPCPeeringWithResponse Delete a VPC Peering
	//
	// Deletes a specific VPC peering connection.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id} (the `DeleteVPCPeering` operationId).
	DeleteVPCPeeringWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, peeringID PeeringID, reqEditors ...RequestEditorFn) (*DeleteVPCPeeringResponse, error)

	// GetVPCPeeringWithResponse Get a VPC Peering
	//
	// Retrieves the details of a specific VPC peering connection.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id} (the `GetVPCPeering` operationId).
	GetVPCPeeringWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, peeringID PeeringID, reqEditors ...RequestEditorFn) (*GetVPCPeeringResponse, error)

	// RenameVPCWithBodyWithResponse Rename a VPC
	//
	// Updates the name of a specific VPC.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/rename (the `RenameVPC` operationId).
	RenameVPCWithBodyWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RenameVPCResponse, error)

	// RenameVPCWithResponse Rename a VPC
	//
	// Updates the name of a specific VPC.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /projects/{project_id}/vpcs/{vpc_id}/rename (the `RenameVPC` operationId).
	RenameVPCWithResponse(ctx context.Context, projectID ProjectID, vpcID VPCId, body RenameVPCJSONRequestBody, reqEditors ...RequestEditorFn) (*RenameVPCResponse, error)
}

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

type ConnectionPooler 

type ConnectionPooler struct {
	// Endpoint A network endpoint for connecting to a service.
	Endpoint *Endpoint `json:"endpoint,omitempty"`
}

ConnectionPooler Connection pooler configuration for a service.

type CreateReplicaSetJSONRequestBody 

type CreateReplicaSetJSONRequestBody = ReadReplicaSetCreate

CreateReplicaSetJSONRequestBody defines body for CreateReplicaSet for application/json ContentType.

type CreateReplicaSetResponse 

type CreateReplicaSetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *ReadReplicaSet
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseCreateReplicaSetResponse 

func ParseCreateReplicaSetResponse(rsp *http.Response) (*CreateReplicaSetResponse, error)

ParseCreateReplicaSetResponse parses an HTTP response from a CreateReplicaSetWithResponse call

func (CreateReplicaSetResponse) ContentType added in v0.24.0 

func (r CreateReplicaSetResponse) ContentType() string

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

func (CreateReplicaSetResponse) GetBody added in v0.24.0 

func (r CreateReplicaSetResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateReplicaSetResponse) GetJSON4XX added in v0.24.0 

func (r CreateReplicaSetResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (CreateReplicaSetResponse) GetJSON202 added in v0.24.0 

func (r CreateReplicaSetResponse) GetJSON202() *ReadReplicaSet

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (CreateReplicaSetResponse) Status 

func (r CreateReplicaSetResponse) Status() string

Status returns HTTPResponse.Status

func (CreateReplicaSetResponse) StatusCode 

func (r CreateReplicaSetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateServiceJSONRequestBody 

type CreateServiceJSONRequestBody = ServiceCreate

CreateServiceJSONRequestBody defines body for CreateService for application/json ContentType.

type CreateServiceResponse 

type CreateServiceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *Service
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseCreateServiceResponse 

func ParseCreateServiceResponse(rsp *http.Response) (*CreateServiceResponse, error)

ParseCreateServiceResponse parses an HTTP response from a CreateServiceWithResponse call

func (CreateServiceResponse) ContentType added in v0.24.0 

func (r CreateServiceResponse) ContentType() string

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

func (CreateServiceResponse) GetBody added in v0.24.0 

func (r CreateServiceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateServiceResponse) GetJSON4XX added in v0.24.0 

func (r CreateServiceResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (CreateServiceResponse) GetJSON202 added in v0.24.0 

func (r CreateServiceResponse) GetJSON202() *Service

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (CreateServiceResponse) Status 

func (r CreateServiceResponse) Status() string

Status returns HTTPResponse.Status

func (CreateServiceResponse) StatusCode 

func (r CreateServiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateVPCJSONRequestBody 

type CreateVPCJSONRequestBody = VPCCreate

CreateVPCJSONRequestBody defines body for CreateVPC for application/json ContentType.

type CreateVPCPeeringJSONRequestBody 

type CreateVPCPeeringJSONRequestBody = PeeringCreate

CreateVPCPeeringJSONRequestBody defines body for CreateVPCPeering for application/json ContentType.

type CreateVPCPeeringResponse 

type CreateVPCPeeringResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *Peering
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseCreateVPCPeeringResponse 

func ParseCreateVPCPeeringResponse(rsp *http.Response) (*CreateVPCPeeringResponse, error)

ParseCreateVPCPeeringResponse parses an HTTP response from a CreateVPCPeeringWithResponse call

func (CreateVPCPeeringResponse) ContentType added in v0.24.0 

func (r CreateVPCPeeringResponse) ContentType() string

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

func (CreateVPCPeeringResponse) GetBody added in v0.24.0 

func (r CreateVPCPeeringResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateVPCPeeringResponse) GetJSON4XX added in v0.24.0 

func (r CreateVPCPeeringResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (CreateVPCPeeringResponse) GetJSON201 added in v0.24.0 

func (r CreateVPCPeeringResponse) GetJSON201() *Peering

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateVPCPeeringResponse) Status 

func (r CreateVPCPeeringResponse) Status() string

Status returns HTTPResponse.Status

func (CreateVPCPeeringResponse) StatusCode 

func (r CreateVPCPeeringResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateVPCResponse 

type CreateVPCResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *VPC
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseCreateVPCResponse 

func ParseCreateVPCResponse(rsp *http.Response) (*CreateVPCResponse, error)

ParseCreateVPCResponse parses an HTTP response from a CreateVPCWithResponse call

func (CreateVPCResponse) ContentType added in v0.24.0 

func (r CreateVPCResponse) ContentType() string

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

func (CreateVPCResponse) GetBody added in v0.24.0 

func (r CreateVPCResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateVPCResponse) GetJSON4XX added in v0.24.0 

func (r CreateVPCResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (CreateVPCResponse) GetJSON201 added in v0.24.0 

func (r CreateVPCResponse) GetJSON201() *VPC

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateVPCResponse) Status 

func (r CreateVPCResponse) Status() string

Status returns HTTPResponse.Status

func (CreateVPCResponse) StatusCode 

func (r CreateVPCResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteReplicaSetResponse 

type DeleteReplicaSetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseDeleteReplicaSetResponse 

func ParseDeleteReplicaSetResponse(rsp *http.Response) (*DeleteReplicaSetResponse, error)

ParseDeleteReplicaSetResponse parses an HTTP response from a DeleteReplicaSetWithResponse call

func (DeleteReplicaSetResponse) ContentType added in v0.24.0 

func (r DeleteReplicaSetResponse) ContentType() string

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

func (DeleteReplicaSetResponse) GetBody added in v0.24.0 

func (r DeleteReplicaSetResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteReplicaSetResponse) GetJSON4XX added in v0.24.0 

func (r DeleteReplicaSetResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (DeleteReplicaSetResponse) Status 

func (r DeleteReplicaSetResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteReplicaSetResponse) StatusCode 

func (r DeleteReplicaSetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteServiceResponse 

type DeleteServiceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseDeleteServiceResponse 

func ParseDeleteServiceResponse(rsp *http.Response) (*DeleteServiceResponse, error)

ParseDeleteServiceResponse parses an HTTP response from a DeleteServiceWithResponse call

func (DeleteServiceResponse) ContentType added in v0.24.0 

func (r DeleteServiceResponse) ContentType() string

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

func (DeleteServiceResponse) GetBody added in v0.24.0 

func (r DeleteServiceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteServiceResponse) GetJSON4XX added in v0.24.0 

func (r DeleteServiceResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (DeleteServiceResponse) Status 

func (r DeleteServiceResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteServiceResponse) StatusCode 

func (r DeleteServiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteVPCPeeringResponse 

type DeleteVPCPeeringResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseDeleteVPCPeeringResponse 

func ParseDeleteVPCPeeringResponse(rsp *http.Response) (*DeleteVPCPeeringResponse, error)

ParseDeleteVPCPeeringResponse parses an HTTP response from a DeleteVPCPeeringWithResponse call

func (DeleteVPCPeeringResponse) ContentType added in v0.24.0 

func (r DeleteVPCPeeringResponse) ContentType() string

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

func (DeleteVPCPeeringResponse) GetBody added in v0.24.0 

func (r DeleteVPCPeeringResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteVPCPeeringResponse) GetJSON4XX added in v0.24.0 

func (r DeleteVPCPeeringResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (DeleteVPCPeeringResponse) Status 

func (r DeleteVPCPeeringResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteVPCPeeringResponse) StatusCode 

func (r DeleteVPCPeeringResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteVPCResponse 

type DeleteVPCResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseDeleteVPCResponse 

func ParseDeleteVPCResponse(rsp *http.Response) (*DeleteVPCResponse, error)

ParseDeleteVPCResponse parses an HTTP response from a DeleteVPCWithResponse call

func (DeleteVPCResponse) ContentType added in v0.24.0 

func (r DeleteVPCResponse) ContentType() string

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

func (DeleteVPCResponse) GetBody added in v0.24.0 

func (r DeleteVPCResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteVPCResponse) GetJSON4XX added in v0.24.0 

func (r DeleteVPCResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (DeleteVPCResponse) Status 

func (r DeleteVPCResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteVPCResponse) StatusCode 

func (r DeleteVPCResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeployStatus 

type DeployStatus string

DeployStatus The current deployment status of the service: - QUEUED: the create request has been submitted and is queued - DELETING: the service is being deleted - CONFIGURING: the service is up but still completing configuration - READY: fully configured and serving traffic - DELETED: the service has been deleted - UNSTABLE: the service was ready but is not currently reachable - PAUSING: the service is being paused - PAUSED: the service is paused (temporarily shut down) - RESUMING: the service is resuming after being paused - UPGRADING: the service is being updated

OPTIMIZING is deprecated and should not be used. 

const (
	DeployStatusCONFIGURING DeployStatus = "CONFIGURING"
	DeployStatusDELETED     DeployStatus = "DELETED"
	DeployStatusDELETING    DeployStatus = "DELETING"
	DeployStatusOPTIMIZING  DeployStatus = "OPTIMIZING"
	DeployStatusPAUSED      DeployStatus = "PAUSED"
	DeployStatusPAUSING     DeployStatus = "PAUSING"
	DeployStatusQUEUED      DeployStatus = "QUEUED"
	DeployStatusREADY       DeployStatus = "READY"
	DeployStatusRESUMING    DeployStatus = "RESUMING"
	DeployStatusUNSTABLE    DeployStatus = "UNSTABLE"
	DeployStatusUPGRADING   DeployStatus = "UPGRADING"
)

Defines values for DeployStatus.

func (DeployStatus) Valid added in v0.24.0 

func (e DeployStatus) Valid() bool

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

type DetachServiceFromVPCJSONRequestBody 

type DetachServiceFromVPCJSONRequestBody = ServiceVPCInput

DetachServiceFromVPCJSONRequestBody defines body for DetachServiceFromVPC for application/json ContentType.

type DetachServiceFromVPCResponse 

type DetachServiceFromVPCResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *SuccessMessage
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseDetachServiceFromVPCResponse 

func ParseDetachServiceFromVPCResponse(rsp *http.Response) (*DetachServiceFromVPCResponse, error)

ParseDetachServiceFromVPCResponse parses an HTTP response from a DetachServiceFromVPCWithResponse call

func (DetachServiceFromVPCResponse) ContentType added in v0.24.0 

func (r DetachServiceFromVPCResponse) ContentType() string

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

func (DetachServiceFromVPCResponse) GetBody added in v0.24.0 

func (r DetachServiceFromVPCResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DetachServiceFromVPCResponse) GetJSON4XX added in v0.24.0 

func (r DetachServiceFromVPCResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (DetachServiceFromVPCResponse) GetJSON202 added in v0.24.0 

func (r DetachServiceFromVPCResponse) GetJSON202() *SuccessMessage

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (DetachServiceFromVPCResponse) Status 

func (r DetachServiceFromVPCResponse) Status() string

Status returns HTTPResponse.Status

func (DetachServiceFromVPCResponse) StatusCode 

func (r DetachServiceFromVPCResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DisablePoolerResponse 

type DisablePoolerResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SuccessMessage
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseDisablePoolerResponse 

func ParseDisablePoolerResponse(rsp *http.Response) (*DisablePoolerResponse, error)

ParseDisablePoolerResponse parses an HTTP response from a DisablePoolerWithResponse call

func (DisablePoolerResponse) ContentType added in v0.24.0 

func (r DisablePoolerResponse) ContentType() string

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

func (DisablePoolerResponse) GetBody added in v0.24.0 

func (r DisablePoolerResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DisablePoolerResponse) GetJSON4XX added in v0.24.0 

func (r DisablePoolerResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (DisablePoolerResponse) GetJSON200 added in v0.24.0 

func (r DisablePoolerResponse) GetJSON200() *SuccessMessage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (DisablePoolerResponse) Status 

func (r DisablePoolerResponse) Status() string

Status returns HTTPResponse.Status

func (DisablePoolerResponse) StatusCode 

func (r DisablePoolerResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DisableReplicaPoolerResponse 

type DisableReplicaPoolerResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SuccessMessage
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseDisableReplicaPoolerResponse 

func ParseDisableReplicaPoolerResponse(rsp *http.Response) (*DisableReplicaPoolerResponse, error)

ParseDisableReplicaPoolerResponse parses an HTTP response from a DisableReplicaPoolerWithResponse call

func (DisableReplicaPoolerResponse) ContentType added in v0.24.0 

func (r DisableReplicaPoolerResponse) ContentType() string

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

func (DisableReplicaPoolerResponse) GetBody added in v0.24.0 

func (r DisableReplicaPoolerResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DisableReplicaPoolerResponse) GetJSON4XX added in v0.24.0 

func (r DisableReplicaPoolerResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (DisableReplicaPoolerResponse) GetJSON200 added in v0.24.0 

func (r DisableReplicaPoolerResponse) GetJSON200() *SuccessMessage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (DisableReplicaPoolerResponse) Status 

func (r DisableReplicaPoolerResponse) Status() string

Status returns HTTPResponse.Status

func (DisableReplicaPoolerResponse) StatusCode 

func (r DisableReplicaPoolerResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EnablePoolerResponse 

type EnablePoolerResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SuccessMessage
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseEnablePoolerResponse 

func ParseEnablePoolerResponse(rsp *http.Response) (*EnablePoolerResponse, error)

ParseEnablePoolerResponse parses an HTTP response from a EnablePoolerWithResponse call

func (EnablePoolerResponse) ContentType added in v0.24.0 

func (r EnablePoolerResponse) ContentType() string

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

func (EnablePoolerResponse) GetBody added in v0.24.0 

func (r EnablePoolerResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (EnablePoolerResponse) GetJSON4XX added in v0.24.0 

func (r EnablePoolerResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (EnablePoolerResponse) GetJSON200 added in v0.24.0 

func (r EnablePoolerResponse) GetJSON200() *SuccessMessage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (EnablePoolerResponse) Status 

func (r EnablePoolerResponse) Status() string

Status returns HTTPResponse.Status

func (EnablePoolerResponse) StatusCode 

func (r EnablePoolerResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EnableReplicaPoolerResponse 

type EnableReplicaPoolerResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SuccessMessage
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseEnableReplicaPoolerResponse 

func ParseEnableReplicaPoolerResponse(rsp *http.Response) (*EnableReplicaPoolerResponse, error)

ParseEnableReplicaPoolerResponse parses an HTTP response from a EnableReplicaPoolerWithResponse call

func (EnableReplicaPoolerResponse) ContentType added in v0.24.0 

func (r EnableReplicaPoolerResponse) ContentType() string

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

func (EnableReplicaPoolerResponse) GetBody added in v0.24.0 

func (r EnableReplicaPoolerResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (EnableReplicaPoolerResponse) GetJSON4XX added in v0.24.0 

func (r EnableReplicaPoolerResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (EnableReplicaPoolerResponse) GetJSON200 added in v0.24.0 

func (r EnableReplicaPoolerResponse) GetJSON200() *SuccessMessage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (EnableReplicaPoolerResponse) Status 

func (r EnableReplicaPoolerResponse) Status() string

Status returns HTTPResponse.Status

func (EnableReplicaPoolerResponse) StatusCode 

func (r EnableReplicaPoolerResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Endpoint 

type Endpoint struct {
	// Host The hostname of the endpoint.
	//
	// Example: i4wmp4crev.oec7sxsza2.tsdb.cloud.timescale.com
	Host *string `json:"host,omitempty"`

	// Port The port of the endpoint.
	//
	// Example: 32625
	Port *int `json:"port,omitempty"`
}

Endpoint A network endpoint for connecting to a service.

type EnvironmentTag 

type EnvironmentTag string

EnvironmentTag The environment tag for the service: - DEV: a development environment - PROD: a production environment 

const (
	EnvironmentTagDEV  EnvironmentTag = "DEV"
	EnvironmentTagPROD EnvironmentTag = "PROD"
)

Defines values for EnvironmentTag.

func (EnvironmentTag) Valid added in v0.24.0 

func (e EnvironmentTag) Valid() bool

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

type Error 

type Error struct {
	// Code A machine-readable error code.
	//
	// Example: NOT_FOUND
	Code *string `json:"code,omitempty"`

	// Message A human-readable error message.
	//
	// Example: The requested service could not be found.
	Message *string `json:"message,omitempty"`
}

Error An error returned when a request cannot be completed.

func (*Error) Error 

func (e *Error) Error() string

type ForkServiceCreate 

type ForkServiceCreate struct {
	// CPUMillis The initial CPU allocation in milli-cores, or 'shared' for a shared-resource service. If not provided, will inherit from parent service.
	//
	// Example: 1000
	CPUMillis *string `json:"cpu_millis,omitempty"`

	// EnvironmentTag The environment tag for the forked service.
	EnvironmentTag *EnvironmentTag `json:"environment_tag,omitempty"`

	// ForkStrategy Strategy for creating the fork:
	// - LAST_SNAPSHOT: Use existing snapshot for fast fork
	// - NOW: Create new snapshot for up-to-date fork
	// - PITR: Point-in-time recovery using target_time
	ForkStrategy ForkStrategy `json:"fork_strategy"`

	// MemoryGbs The initial memory allocation in gigabytes, or 'shared' for a shared-resource service. If not provided, will inherit from parent service.
	//
	// Example: 4
	MemoryGbs *string `json:"memory_gbs,omitempty"`

	// Name A human-readable name for the forked service. If not provided, will use parent service name with "-fork" suffix.
	//
	// Example: my-production-db-fork
	Name *string `json:"name,omitempty"`

	// TargetTime Target time for point-in-time recovery. Required when fork_strategy is PITR.
	//
	// Example: 2024-01-01T00:00:00Z
	TargetTime *time.Time `json:"target_time,omitempty"`
}

ForkServiceCreate Create a fork of an existing service. Service type, region code, and storage are always inherited from the parent service. HA replica count is always set to 0 for forked services.

type ForkServiceJSONRequestBody 

type ForkServiceJSONRequestBody = ForkServiceCreate

ForkServiceJSONRequestBody defines body for ForkService for application/json ContentType.

type ForkServiceResponse 

type ForkServiceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *Service
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseForkServiceResponse 

func ParseForkServiceResponse(rsp *http.Response) (*ForkServiceResponse, error)

ParseForkServiceResponse parses an HTTP response from a ForkServiceWithResponse call

func (ForkServiceResponse) ContentType added in v0.24.0 

func (r ForkServiceResponse) ContentType() string

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

func (ForkServiceResponse) GetBody added in v0.24.0 

func (r ForkServiceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ForkServiceResponse) GetJSON4XX added in v0.24.0 

func (r ForkServiceResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (ForkServiceResponse) GetJSON202 added in v0.24.0 

func (r ForkServiceResponse) GetJSON202() *Service

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (ForkServiceResponse) Status 

func (r ForkServiceResponse) Status() string

Status returns HTTPResponse.Status

func (ForkServiceResponse) StatusCode 

func (r ForkServiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ForkSpec 

type ForkSpec struct {
	// IsStandby Whether this service is a standby of the parent service.
	//
	// Example: false
	IsStandby *bool `json:"is_standby,omitempty"`

	// ProjectID The project of the parent service.
	//
	// Example: rp1pz7uyae
	ProjectID *string `json:"project_id,omitempty"`

	// ServiceID The ID of the parent service.
	//
	// Example: kd9w2xp4mz
	ServiceID *string `json:"service_id,omitempty"`
}

ForkSpec The service this service was forked from.

type ForkStrategy 

type ForkStrategy string

ForkStrategy Strategy for creating the fork: - LAST_SNAPSHOT: Use existing snapshot for fast fork - NOW: Create new snapshot for up-to-date fork - PITR: Point-in-time recovery using target_time 

const (
	ForkStrategyLASTSNAPSHOT ForkStrategy = "LAST_SNAPSHOT"
	ForkStrategyNOW          ForkStrategy = "NOW"
	ForkStrategyPITR         ForkStrategy = "PITR"
)

Defines values for ForkStrategy.

func (ForkStrategy) Valid added in v0.24.0 

func (e ForkStrategy) Valid() bool

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

type GetAuthInfoResponse 

type GetAuthInfoResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AuthInfo
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseGetAuthInfoResponse 

func ParseGetAuthInfoResponse(rsp *http.Response) (*GetAuthInfoResponse, error)

ParseGetAuthInfoResponse parses an HTTP response from a GetAuthInfoWithResponse call

func (GetAuthInfoResponse) ContentType added in v0.24.0 

func (r GetAuthInfoResponse) ContentType() string

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

func (GetAuthInfoResponse) GetBody added in v0.24.0 

func (r GetAuthInfoResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetAuthInfoResponse) GetJSON4XX added in v0.24.0 

func (r GetAuthInfoResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (GetAuthInfoResponse) GetJSON200 added in v0.24.0 

func (r GetAuthInfoResponse) GetJSON200() *AuthInfo

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetAuthInfoResponse) Status 

func (r GetAuthInfoResponse) Status() string

Status returns HTTPResponse.Status

func (GetAuthInfoResponse) StatusCode 

func (r GetAuthInfoResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBackupsResponse added in v0.23.0 

type GetBackupsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]Backup
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseGetBackupsResponse added in v0.23.0 

func ParseGetBackupsResponse(rsp *http.Response) (*GetBackupsResponse, error)

ParseGetBackupsResponse parses an HTTP response from a GetBackupsWithResponse call

func (GetBackupsResponse) ContentType added in v0.24.0 

func (r GetBackupsResponse) ContentType() string

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

func (GetBackupsResponse) GetBody added in v0.24.0 

func (r GetBackupsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetBackupsResponse) GetJSON4XX added in v0.24.0 

func (r GetBackupsResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (GetBackupsResponse) GetJSON200 added in v0.24.0 

func (r GetBackupsResponse) GetJSON200() *[]Backup

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetBackupsResponse) Status added in v0.23.0 

func (r GetBackupsResponse) Status() string

Status returns HTTPResponse.Status

func (GetBackupsResponse) StatusCode added in v0.23.0 

func (r GetBackupsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetProjectsResponse 

type GetProjectsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]Project
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseGetProjectsResponse 

func ParseGetProjectsResponse(rsp *http.Response) (*GetProjectsResponse, error)

ParseGetProjectsResponse parses an HTTP response from a GetProjectsWithResponse call

func (GetProjectsResponse) ContentType added in v0.24.0 

func (r GetProjectsResponse) ContentType() string

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

func (GetProjectsResponse) GetBody added in v0.24.0 

func (r GetProjectsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetProjectsResponse) GetJSON4XX added in v0.24.0 

func (r GetProjectsResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (GetProjectsResponse) GetJSON200 added in v0.24.0 

func (r GetProjectsResponse) GetJSON200() *[]Project

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetProjectsResponse) Status 

func (r GetProjectsResponse) Status() string

Status returns HTTPResponse.Status

func (GetProjectsResponse) StatusCode 

func (r GetProjectsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetReplicaSetsResponse 

type GetReplicaSetsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]ReadReplicaSet
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseGetReplicaSetsResponse 

func ParseGetReplicaSetsResponse(rsp *http.Response) (*GetReplicaSetsResponse, error)

ParseGetReplicaSetsResponse parses an HTTP response from a GetReplicaSetsWithResponse call

func (GetReplicaSetsResponse) ContentType added in v0.24.0 

func (r GetReplicaSetsResponse) ContentType() string

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

func (GetReplicaSetsResponse) GetBody added in v0.24.0 

func (r GetReplicaSetsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetReplicaSetsResponse) GetJSON4XX added in v0.24.0 

func (r GetReplicaSetsResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (GetReplicaSetsResponse) GetJSON200 added in v0.24.0 

func (r GetReplicaSetsResponse) GetJSON200() *[]ReadReplicaSet

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetReplicaSetsResponse) Status 

func (r GetReplicaSetsResponse) Status() string

Status returns HTTPResponse.Status

func (GetReplicaSetsResponse) StatusCode 

func (r GetReplicaSetsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetServiceLogsParams 

type GetServiceLogsParams struct {
	// Node Specific service node to fetch logs from (for multi-node services).
	Node *int `form:"node,omitempty" json:"node,omitempty"`

	// Cursor Opaque pagination cursor returned as `last_cursor` in a previous response.
	// When provided, returns the next page of logs older than the cursor position.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// Until Upper bound timestamp — fetch logs before this time (RFC3339 format, e.g., 2024-01-15T10:00:00Z).
	Until *time.Time `form:"until,omitempty" json:"until,omitempty"`

	// Since Lower bound timestamp — fetch logs after this time (RFC3339 format).
	Since *time.Time `form:"since,omitempty" json:"since,omitempty"`

	// Search Full-text search terms to filter log lines. Repeat the parameter for multiple values
	// (e.g. `?search=slow+query&search=ERROR`).
	Search *[]string `form:"search,omitempty" json:"search,omitempty"`

	// Severities Severity levels to filter results. Repeat the parameter for multiple values
	// (e.g. `?severities=ERROR&severities=WARNING`).
	Severities *[]string `form:"severities,omitempty" json:"severities,omitempty"`
}

GetServiceLogsParams defines parameters for GetServiceLogs.

type GetServiceLogsResponse 

type GetServiceLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ServiceLogs
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseGetServiceLogsResponse 

func ParseGetServiceLogsResponse(rsp *http.Response) (*GetServiceLogsResponse, error)

ParseGetServiceLogsResponse parses an HTTP response from a GetServiceLogsWithResponse call

func (GetServiceLogsResponse) ContentType added in v0.24.0 

func (r GetServiceLogsResponse) ContentType() string

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

func (GetServiceLogsResponse) GetBody added in v0.24.0 

func (r GetServiceLogsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetServiceLogsResponse) GetJSON4XX added in v0.24.0 

func (r GetServiceLogsResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (GetServiceLogsResponse) GetJSON200 added in v0.24.0 

func (r GetServiceLogsResponse) GetJSON200() *ServiceLogs

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetServiceLogsResponse) Status 

func (r GetServiceLogsResponse) Status() string

Status returns HTTPResponse.Status

func (GetServiceLogsResponse) StatusCode 

func (r GetServiceLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetServiceMetricsAvailableSeriesResponse 

type GetServiceMetricsAvailableSeriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]string
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseGetServiceMetricsAvailableSeriesResponse 

func ParseGetServiceMetricsAvailableSeriesResponse(rsp *http.Response) (*GetServiceMetricsAvailableSeriesResponse, error)

ParseGetServiceMetricsAvailableSeriesResponse parses an HTTP response from a GetServiceMetricsAvailableSeriesWithResponse call

func (GetServiceMetricsAvailableSeriesResponse) ContentType added in v0.24.0 

func (r GetServiceMetricsAvailableSeriesResponse) ContentType() string

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

func (GetServiceMetricsAvailableSeriesResponse) GetBody added in v0.24.0 

func (r GetServiceMetricsAvailableSeriesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetServiceMetricsAvailableSeriesResponse) GetJSON4XX added in v0.24.0 

func (r GetServiceMetricsAvailableSeriesResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (GetServiceMetricsAvailableSeriesResponse) GetJSON200 added in v0.24.0 

func (r GetServiceMetricsAvailableSeriesResponse) GetJSON200() *[]string

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetServiceMetricsAvailableSeriesResponse) Status 

func (r GetServiceMetricsAvailableSeriesResponse) Status() string

Status returns HTTPResponse.Status

func (GetServiceMetricsAvailableSeriesResponse) StatusCode 

func (r GetServiceMetricsAvailableSeriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetServiceMetricsSeriesJSONRequestBody 

type GetServiceMetricsSeriesJSONRequestBody = MetricsSeriesRequest

GetServiceMetricsSeriesJSONRequestBody defines body for GetServiceMetricsSeries for application/json ContentType.

type GetServiceMetricsSeriesResponse 

type GetServiceMetricsSeriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]MetricSeries
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseGetServiceMetricsSeriesResponse 

func ParseGetServiceMetricsSeriesResponse(rsp *http.Response) (*GetServiceMetricsSeriesResponse, error)

ParseGetServiceMetricsSeriesResponse parses an HTTP response from a GetServiceMetricsSeriesWithResponse call

func (GetServiceMetricsSeriesResponse) ContentType added in v0.24.0 

func (r GetServiceMetricsSeriesResponse) ContentType() string

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

func (GetServiceMetricsSeriesResponse) GetBody added in v0.24.0 

func (r GetServiceMetricsSeriesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetServiceMetricsSeriesResponse) GetJSON4XX added in v0.24.0 

func (r GetServiceMetricsSeriesResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (GetServiceMetricsSeriesResponse) GetJSON200 added in v0.24.0 

func (r GetServiceMetricsSeriesResponse) GetJSON200() *[]MetricSeries

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetServiceMetricsSeriesResponse) Status 

func (r GetServiceMetricsSeriesResponse) Status() string

Status returns HTTPResponse.Status

func (GetServiceMetricsSeriesResponse) StatusCode 

func (r GetServiceMetricsSeriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetServiceResponse 

type GetServiceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Service
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseGetServiceResponse 

func ParseGetServiceResponse(rsp *http.Response) (*GetServiceResponse, error)

ParseGetServiceResponse parses an HTTP response from a GetServiceWithResponse call

func (GetServiceResponse) ContentType added in v0.24.0 

func (r GetServiceResponse) ContentType() string

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

func (GetServiceResponse) GetBody added in v0.24.0 

func (r GetServiceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetServiceResponse) GetJSON4XX added in v0.24.0 

func (r GetServiceResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (GetServiceResponse) GetJSON200 added in v0.24.0 

func (r GetServiceResponse) GetJSON200() *Service

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetServiceResponse) Status 

func (r GetServiceResponse) Status() string

Status returns HTTPResponse.Status

func (GetServiceResponse) StatusCode 

func (r GetServiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetServicesResponse 

type GetServicesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]Service
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseGetServicesResponse 

func ParseGetServicesResponse(rsp *http.Response) (*GetServicesResponse, error)

ParseGetServicesResponse parses an HTTP response from a GetServicesWithResponse call

func (GetServicesResponse) ContentType added in v0.24.0 

func (r GetServicesResponse) ContentType() string

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

func (GetServicesResponse) GetBody added in v0.24.0 

func (r GetServicesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetServicesResponse) GetJSON4XX added in v0.24.0 

func (r GetServicesResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (GetServicesResponse) GetJSON200 added in v0.24.0 

func (r GetServicesResponse) GetJSON200() *[]Service

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetServicesResponse) Status 

func (r GetServicesResponse) Status() string

Status returns HTTPResponse.Status

func (GetServicesResponse) StatusCode 

func (r GetServicesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVPCPeeringResponse 

type GetVPCPeeringResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Peering
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseGetVPCPeeringResponse 

func ParseGetVPCPeeringResponse(rsp *http.Response) (*GetVPCPeeringResponse, error)

ParseGetVPCPeeringResponse parses an HTTP response from a GetVPCPeeringWithResponse call

func (GetVPCPeeringResponse) ContentType added in v0.24.0 

func (r GetVPCPeeringResponse) ContentType() string

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

func (GetVPCPeeringResponse) GetBody added in v0.24.0 

func (r GetVPCPeeringResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetVPCPeeringResponse) GetJSON4XX added in v0.24.0 

func (r GetVPCPeeringResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (GetVPCPeeringResponse) GetJSON200 added in v0.24.0 

func (r GetVPCPeeringResponse) GetJSON200() *Peering

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetVPCPeeringResponse) Status 

func (r GetVPCPeeringResponse) Status() string

Status returns HTTPResponse.Status

func (GetVPCPeeringResponse) StatusCode 

func (r GetVPCPeeringResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVPCPeeringsResponse 

type GetVPCPeeringsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]Peering
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseGetVPCPeeringsResponse 

func ParseGetVPCPeeringsResponse(rsp *http.Response) (*GetVPCPeeringsResponse, error)

ParseGetVPCPeeringsResponse parses an HTTP response from a GetVPCPeeringsWithResponse call

func (GetVPCPeeringsResponse) ContentType added in v0.24.0 

func (r GetVPCPeeringsResponse) ContentType() string

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

func (GetVPCPeeringsResponse) GetBody added in v0.24.0 

func (r GetVPCPeeringsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetVPCPeeringsResponse) GetJSON4XX added in v0.24.0 

func (r GetVPCPeeringsResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (GetVPCPeeringsResponse) GetJSON200 added in v0.24.0 

func (r GetVPCPeeringsResponse) GetJSON200() *[]Peering

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetVPCPeeringsResponse) Status 

func (r GetVPCPeeringsResponse) Status() string

Status returns HTTPResponse.Status

func (GetVPCPeeringsResponse) StatusCode 

func (r GetVPCPeeringsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVPCResponse 

type GetVPCResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *VPC
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseGetVPCResponse 

func ParseGetVPCResponse(rsp *http.Response) (*GetVPCResponse, error)

ParseGetVPCResponse parses an HTTP response from a GetVPCWithResponse call

func (GetVPCResponse) ContentType added in v0.24.0 

func (r GetVPCResponse) ContentType() string

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

func (GetVPCResponse) GetBody added in v0.24.0 

func (r GetVPCResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetVPCResponse) GetJSON4XX added in v0.24.0 

func (r GetVPCResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (GetVPCResponse) GetJSON200 added in v0.24.0 

func (r GetVPCResponse) GetJSON200() *VPC

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetVPCResponse) Status 

func (r GetVPCResponse) Status() string

Status returns HTTPResponse.Status

func (GetVPCResponse) StatusCode 

func (r GetVPCResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVPCsResponse 

type GetVPCsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]VPC
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseGetVPCsResponse 

func ParseGetVPCsResponse(rsp *http.Response) (*GetVPCsResponse, error)

ParseGetVPCsResponse parses an HTTP response from a GetVPCsWithResponse call

func (GetVPCsResponse) ContentType added in v0.24.0 

func (r GetVPCsResponse) ContentType() string

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

func (GetVPCsResponse) GetBody added in v0.24.0 

func (r GetVPCsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetVPCsResponse) GetJSON4XX added in v0.24.0 

func (r GetVPCsResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (GetVPCsResponse) GetJSON200 added in v0.24.0 

func (r GetVPCsResponse) GetJSON200() *[]VPC

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetVPCsResponse) Status 

func (r GetVPCsResponse) Status() string

Status returns HTTPResponse.Status

func (GetVPCsResponse) StatusCode 

func (r GetVPCsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HAReplica 

type HAReplica struct {
	// ReplicaCount Number of high-availability replicas (all replicas are asynchronous by default).
	//
	// Example: 1
	ReplicaCount *int `json:"replica_count,omitempty"`

	// SyncReplicaCount Number of synchronous high-availability replicas.
	//
	// Example: 1
	SyncReplicaCount *int `json:"sync_replica_count,omitempty"`
}

HAReplica High-availability replica configuration for a service.

type HttpRequestDoer 

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type IdentifyUserJSONBody 

type IdentifyUserJSONBody struct {
	// Properties Optional map of arbitrary properties associated with the user.
	//
	// Example: {"email":"user@example.com","name":"John Doe"}
	Properties *map[string]interface{} `json:"properties,omitempty"`
}

IdentifyUserJSONBody defines parameters for IdentifyUser.

type IdentifyUserJSONRequestBody 

type IdentifyUserJSONRequestBody IdentifyUserJSONBody

IdentifyUserJSONRequestBody defines body for IdentifyUser for application/json ContentType.

type IdentifyUserResponse 

type IdentifyUserResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AnalyticsResponse
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseIdentifyUserResponse 

func ParseIdentifyUserResponse(rsp *http.Response) (*IdentifyUserResponse, error)

ParseIdentifyUserResponse parses an HTTP response from a IdentifyUserWithResponse call

func (IdentifyUserResponse) ContentType added in v0.24.0 

func (r IdentifyUserResponse) ContentType() string

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

func (IdentifyUserResponse) GetBody added in v0.24.0 

func (r IdentifyUserResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (IdentifyUserResponse) GetJSON4XX added in v0.24.0 

func (r IdentifyUserResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (IdentifyUserResponse) GetJSON200 added in v0.24.0 

func (r IdentifyUserResponse) GetJSON200() *AnalyticsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (IdentifyUserResponse) Status 

func (r IdentifyUserResponse) Status() string

Status returns HTTPResponse.Status

func (IdentifyUserResponse) StatusCode 

func (r IdentifyUserResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type LogoutJSONBody 

type LogoutJSONBody struct {
	// RefreshToken The OAuth refresh token to revoke. Omit for sessions without a refresh token.
	RefreshToken *string `json:"refresh_token,omitempty"`
}

LogoutJSONBody defines parameters for Logout.

type LogoutJSONRequestBody 

type LogoutJSONRequestBody LogoutJSONBody

LogoutJSONRequestBody defines body for Logout for application/json ContentType.

type LogoutResponse 

type LogoutResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseLogoutResponse 

func ParseLogoutResponse(rsp *http.Response) (*LogoutResponse, error)

ParseLogoutResponse parses an HTTP response from a LogoutWithResponse call

func (LogoutResponse) ContentType added in v0.24.0 

func (r LogoutResponse) ContentType() string

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

func (LogoutResponse) GetBody added in v0.24.0 

func (r LogoutResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (LogoutResponse) GetJSON4XX added in v0.24.0 

func (r LogoutResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (LogoutResponse) Status 

func (r LogoutResponse) Status() string

Status returns HTTPResponse.Status

func (LogoutResponse) StatusCode 

func (r LogoutResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MetricDataPoint 

type MetricDataPoint struct {
	// Time The bucket start timestamp.
	//
	// Example: 2026-06-25T10:00:00Z
	Time time.Time `json:"time"`

	// Value The aggregated value at this bucket, or null for a gap bucket with
	// no collected data. Gap buckets are still emitted (one entry per
	// bucket in the window), so this is null rather than omitted.
	//
	//
	// Example: 247.5
	Value *float64 `json:"value"`
}

MetricDataPoint A single time/value pair within a MetricSeries.

type MetricLabelFilter 

type MetricLabelFilter struct {
	// Key Label key to match against, e.g. `role` or `job_id`.
	//
	// Example: role
	Key string `json:"key"`

	// Value Label value to match. Case sensitivity follows the underlying metric's storage convention.
	//
	// Example: primary
	Value string `json:"value"`
}

MetricLabelFilter A single key/value label match applied to a metric series query.

type MetricSeries 

type MetricSeries struct {
	// Data Per-bucket data points for this label set.
	Data []MetricDataPoint `json:"data"`

	// Labels Label set identifying this series. The key set depends on the
	// metric (e.g. `role`, `ordinal`).
	Labels map[string]string `json:"labels"`
}

MetricSeries One labeled time series — the label set plus its per-bucket data points.

type MetricsSeriesRequest 

type MetricsSeriesRequest struct {
	// BucketSeconds Aggregation bucket size in seconds. Optional: when omitted the
	// server picks a default that matches the window (roughly 1m for
	// windows up to 1h, 1h for up to 30d, 1d beyond that). Minimum is
	// 60s (finer buckets don't add resolution given scrape intervals).
	// Must be coarse enough for the window's tier; requests that ask
	// for a finer bucket than the tier can produce are rejected.
	//
	//
	// Example: 3600
	BucketSeconds *int `json:"bucket_seconds,omitempty"`

	// Filters Label filters applied to the series query. Recognized label names
	// depend on the metric. The most common is `role` (value `primary` or
	// `replica`). When `role` is omitted, some metrics default to primary
	// and others return data for all roles (one series per role); pass an
	// explicit role for deterministic results. Role label values in the
	// response are lowercased.
	Filters *[]MetricLabelFilter `json:"filters,omitempty"`

	// Fn Aggregation function applied to raw/pre-aggregated samples when
	// collapsing them into one value per output bucket. Optional: when
	// omitted the server picks the default for the metric (currently
	// `LAST`).
	//
	// Not accepted on the following metrics — requests are rejected
	// with `INVALID_REQUEST`:
	//   - `timescale_cloud_system_cpu_total_millicores`
	//   - `timescale_cloud_system_cpu_usage_millicores`
	//   - `timescale_cloud_system_disk_io_read_bytes`
	//   - `timescale_cloud_system_disk_io_read_ops`
	//   - `timescale_cloud_system_disk_io_total_bytes`
	//   - `timescale_cloud_system_disk_io_total_ops`
	//   - `timescale_cloud_system_disk_io_write_bytes`
	//   - `timescale_cloud_system_disk_io_write_ops`
	//   - `timescale_cloud_system_disk_usage_bytes`
	//   - `timescale_cloud_system_memory_total_bytes`
	//   - `timescale_cloud_system_memory_usage_bytes`
	//   - `timescale_cloud_database_qps`
	//   - `timescale_cloud_database_num_connections`
	//   - `timescale_cloud_database_job_duration_usecs`
	//   - `timescale_cloud_database_job_success`
	//
	// Values:
	//   - `RATE`: counter-reset-aware per-second rate of change.
	//   - `INCREASE`: counter-reset-aware total increase over the bucket.
	//   - `SUM`: sum of samples in the bucket.
	//   - `AVG`: mean of samples in the bucket.
	//   - `MIN`: minimum sample in the bucket.
	//   - `MAX`: maximum sample in the bucket.
	//   - `COUNT`: number of samples in the bucket.
	//   - `P50` / `P90` / `P99`: percentile approximations (only valid
	//     for metrics stored as sketches).
	//   - `LAST`: the most recent sample in the bucket (default).
	//
	//
	// Example: RATE
	Fn *MetricsSeriesRequestFn `json:"fn,omitempty"`

	// From Start of the time window (RFC3339; nanosecond precision accepted).
	//
	// Example: 2026-06-25T10:00:00Z
	From time.Time `json:"from"`

	// Name Metric series name. Use getServiceMetricsAvailableSeries to discover valid values.
	//
	// Example: timescale_cloud_system_cpu_usage_millicores
	Name string `json:"name"`

	// To End of the time window (RFC3339; nanosecond precision accepted).
	//
	// Example: 2026-06-25T11:00:00Z
	To time.Time `json:"to"`
}

MetricsSeriesRequest Parameters for a single getServiceMetricsSeries query. Sent as a JSON body so callers can pass an unbounded filter set without query-string length pressure.

type MetricsSeriesRequestFn 

type MetricsSeriesRequestFn string

MetricsSeriesRequestFn Aggregation function applied to raw/pre-aggregated samples when collapsing them into one value per output bucket. Optional: when omitted the server picks the default for the metric (currently `LAST`).

Not accepted on the following metrics — requests are rejected with `INVALID_REQUEST`:

  • `timescale_cloud_system_cpu_total_millicores`
  • `timescale_cloud_system_cpu_usage_millicores`
  • `timescale_cloud_system_disk_io_read_bytes`
  • `timescale_cloud_system_disk_io_read_ops`
  • `timescale_cloud_system_disk_io_total_bytes`
  • `timescale_cloud_system_disk_io_total_ops`
  • `timescale_cloud_system_disk_io_write_bytes`
  • `timescale_cloud_system_disk_io_write_ops`
  • `timescale_cloud_system_disk_usage_bytes`
  • `timescale_cloud_system_memory_total_bytes`
  • `timescale_cloud_system_memory_usage_bytes`
  • `timescale_cloud_database_qps`
  • `timescale_cloud_database_num_connections`
  • `timescale_cloud_database_job_duration_usecs`
  • `timescale_cloud_database_job_success`

Values:

  • `RATE`: counter-reset-aware per-second rate of change.
  • `INCREASE`: counter-reset-aware total increase over the bucket.
  • `SUM`: sum of samples in the bucket.
  • `AVG`: mean of samples in the bucket.
  • `MIN`: minimum sample in the bucket.
  • `MAX`: maximum sample in the bucket.
  • `COUNT`: number of samples in the bucket.
  • `P50` / `P90` / `P99`: percentile approximations (only valid for metrics stored as sketches).
  • `LAST`: the most recent sample in the bucket (default).

Example: RATE 

const (
	MetricsSeriesRequestFnAVG      MetricsSeriesRequestFn = "AVG"
	MetricsSeriesRequestFnCOUNT    MetricsSeriesRequestFn = "COUNT"
	MetricsSeriesRequestFnINCREASE MetricsSeriesRequestFn = "INCREASE"
	MetricsSeriesRequestFnLAST     MetricsSeriesRequestFn = "LAST"
	MetricsSeriesRequestFnMAX      MetricsSeriesRequestFn = "MAX"
	MetricsSeriesRequestFnMIN      MetricsSeriesRequestFn = "MIN"
	MetricsSeriesRequestFnP50      MetricsSeriesRequestFn = "P50"
	MetricsSeriesRequestFnP90      MetricsSeriesRequestFn = "P90"
	MetricsSeriesRequestFnP99      MetricsSeriesRequestFn = "P99"
	MetricsSeriesRequestFnRATE     MetricsSeriesRequestFn = "RATE"
	MetricsSeriesRequestFnSUM      MetricsSeriesRequestFn = "SUM"
)

Defines values for MetricsSeriesRequestFn.

func (MetricsSeriesRequestFn) Valid added in v0.24.0 

func (e MetricsSeriesRequestFn) Valid() bool

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

type Peering 

type Peering struct {
	// ErrorMessage A human-readable error message when the peering connection failed.
	//
	// Example: VPC not found
	ErrorMessage *string `json:"error_message,omitempty"`

	// ID The unique identifier for the peering connection.
	//
	// Example: 1234567890
	ID *string `json:"id,omitempty"`

	// PeerAccountID The cloud account ID of the peer VPC.
	//
	// Example: acc-12345
	PeerAccountID string `json:"peer_account_id"`

	// PeerRegionCode The cloud region of the peer VPC.
	//
	// Example: us-east-1
	PeerRegionCode string `json:"peer_region_code"`

	// PeerVpcID The ID of the peer VPC.
	//
	// Example: 1234567890
	PeerVpcID string `json:"peer_vpc_id"`

	// ProvisionedID The provider-assigned identifier for the provisioned peering.
	//
	// Example: 1234567890
	ProvisionedID *string `json:"provisioned_id,omitempty"`

	// Status The current status of the peering connection.
	//
	// Example: active
	Status *string `json:"status,omitempty"`
}

Peering A VPC peering connection to an external cloud account.

type PeeringCreate 

type PeeringCreate struct {
	// PeerAccountID The cloud account ID of the peer VPC.
	//
	// Example: acc-12345
	PeerAccountID string `json:"peer_account_id"`

	// PeerRegionCode The cloud region of the peer VPC.
	//
	// Example: us-east-1
	PeerRegionCode string `json:"peer_region_code"`

	// PeerVpcID The ID of the peer VPC.
	//
	// Example: 1234567890
	PeerVpcID string `json:"peer_vpc_id"`
}

PeeringCreate Parameters for creating a VPC peering connection.

type PeeringID 

type PeeringID = string

PeeringID Example: 1234567890

type Project 

type Project struct {
	// ID The unique identifier for the project.
	//
	// Example: rp1pz7uyae
	ID string `json:"id"`

	// Name The name of the project.
	//
	// Example: My Production Project
	Name string `json:"name"`
}

Project A project that organizes your Tiger Cloud resources, such as services and VPCs.

type ProjectID 

type ProjectID = string

ProjectID Example: rp1pz7uyae

type ReadReplicaSet 

type ReadReplicaSet struct {
	// ConnectionPooler Connection pooler configuration for a service.
	ConnectionPooler *ConnectionPooler `json:"connection_pooler,omitempty"`

	// CPUMillis CPU allocation in milli-cores.
	//
	// Example: 250
	CPUMillis int `json:"cpu_millis"`

	// Endpoint A network endpoint for connecting to a service.
	Endpoint *Endpoint `json:"endpoint,omitempty"`

	// ID The unique identifier for the read replica set.
	//
	// Example: alb8jicdpr
	ID string `json:"id"`

	// MemoryGbs Memory allocation in gigabytes.
	//
	// Example: 1
	MemoryGbs int `json:"memory_gbs"`

	// Metadata Additional metadata for the read replica set.
	Metadata *ReplicaSetMetadata `json:"metadata,omitempty"`

	// Name The name of the read replica set.
	//
	// Example: reporting-replica-1
	Name string `json:"name"`

	// Nodes Number of nodes in the replica set.
	//
	// Example: 2
	Nodes int `json:"nodes"`

	// Status The current status of the read replica set:
	// - creating: the replica set is being provisioned
	// - active: the replica set is provisioned and serving traffic
	// - resizing: the replica set is being resized
	// - deleting: the replica set is being deleted
	// - error: the replica set is in an error state
	//
	//
	// Example: active
	Status ReadReplicaSetStatus `json:"status"`
}

ReadReplicaSet A set of read replicas for a service.

type ReadReplicaSetCreate 

type ReadReplicaSetCreate struct {
	// CPUMillis The initial CPU allocation in milli-cores.
	//
	// Example: 250
	CPUMillis int `json:"cpu_millis"`

	// MemoryGbs The initial memory allocation in gigabytes.
	//
	// Example: 1
	MemoryGbs int `json:"memory_gbs"`

	// Name A human-readable name for the read replica.
	//
	// Example: my-reporting-replica
	Name string `json:"name"`

	// Nodes Number of nodes to create in the replica set.
	//
	// Example: 2
	Nodes int `json:"nodes"`
}

ReadReplicaSetCreate Parameters for creating a read replica set.

type ReadReplicaSetStatus 

type ReadReplicaSetStatus string

ReadReplicaSetStatus The current status of the read replica set: - creating: the replica set is being provisioned - active: the replica set is provisioned and serving traffic - resizing: the replica set is being resized - deleting: the replica set is being deleted - error: the replica set is in an error state

Example: active 

const (
	ReadReplicaSetStatusActive   ReadReplicaSetStatus = "active"
	ReadReplicaSetStatusCreating ReadReplicaSetStatus = "creating"
	ReadReplicaSetStatusDeleting ReadReplicaSetStatus = "deleting"
	ReadReplicaSetStatusError    ReadReplicaSetStatus = "error"
	ReadReplicaSetStatusResizing ReadReplicaSetStatus = "resizing"
)

Defines values for ReadReplicaSetStatus.

func (ReadReplicaSetStatus) Valid added in v0.24.0 

func (e ReadReplicaSetStatus) Valid() bool

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

type RenameServiceJSONRequestBody 

type RenameServiceJSONRequestBody = ServiceRename

RenameServiceJSONRequestBody defines body for RenameService for application/json ContentType.

type RenameServiceResponse 

type RenameServiceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Service
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseRenameServiceResponse 

func ParseRenameServiceResponse(rsp *http.Response) (*RenameServiceResponse, error)

ParseRenameServiceResponse parses an HTTP response from a RenameServiceWithResponse call

func (RenameServiceResponse) ContentType added in v0.24.0 

func (r RenameServiceResponse) ContentType() string

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

func (RenameServiceResponse) GetBody added in v0.24.0 

func (r RenameServiceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RenameServiceResponse) GetJSON4XX added in v0.24.0 

func (r RenameServiceResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (RenameServiceResponse) GetJSON200 added in v0.24.0 

func (r RenameServiceResponse) GetJSON200() *Service

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (RenameServiceResponse) Status 

func (r RenameServiceResponse) Status() string

Status returns HTTPResponse.Status

func (RenameServiceResponse) StatusCode 

func (r RenameServiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RenameVPCJSONRequestBody 

type RenameVPCJSONRequestBody = VPCRename

RenameVPCJSONRequestBody defines body for RenameVPC for application/json ContentType.

type RenameVPCResponse 

type RenameVPCResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SuccessMessage
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseRenameVPCResponse 

func ParseRenameVPCResponse(rsp *http.Response) (*RenameVPCResponse, error)

ParseRenameVPCResponse parses an HTTP response from a RenameVPCWithResponse call

func (RenameVPCResponse) ContentType added in v0.24.0 

func (r RenameVPCResponse) ContentType() string

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

func (RenameVPCResponse) GetBody added in v0.24.0 

func (r RenameVPCResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RenameVPCResponse) GetJSON4XX added in v0.24.0 

func (r RenameVPCResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (RenameVPCResponse) GetJSON200 added in v0.24.0 

func (r RenameVPCResponse) GetJSON200() *SuccessMessage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (RenameVPCResponse) Status 

func (r RenameVPCResponse) Status() string

Status returns HTTPResponse.Status

func (RenameVPCResponse) StatusCode 

func (r RenameVPCResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReplicaSetID 

type ReplicaSetID = string

ReplicaSetID Example: alb8jicdpr

type ReplicaSetMetadata 

type ReplicaSetMetadata struct {
	// Environment Environment tag for the read replica set.
	//
	// Example: PROD
	Environment *string `json:"environment,omitempty"`
}

ReplicaSetMetadata Additional metadata for the read replica set.

type RequestEditorFn 

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

RequestEditorFn is the function signature for the RequestEditor callback function

type ResizeInput 

type ResizeInput struct {
	// CPUMillis The new CPU allocation in milli-cores.
	//
	// Example: 1000
	CPUMillis string `json:"cpu_millis"`

	// MemoryGbs The new memory allocation in gigabytes.
	//
	// Example: 4
	MemoryGbs string `json:"memory_gbs"`
}

ResizeInput Parameters for resizing a service.

type ResizeReplicaSetJSONRequestBody 

type ResizeReplicaSetJSONRequestBody = ResizeInput

ResizeReplicaSetJSONRequestBody defines body for ResizeReplicaSet for application/json ContentType.

type ResizeReplicaSetResponse 

type ResizeReplicaSetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *SuccessMessage
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseResizeReplicaSetResponse 

func ParseResizeReplicaSetResponse(rsp *http.Response) (*ResizeReplicaSetResponse, error)

ParseResizeReplicaSetResponse parses an HTTP response from a ResizeReplicaSetWithResponse call

func (ResizeReplicaSetResponse) ContentType added in v0.24.0 

func (r ResizeReplicaSetResponse) ContentType() string

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

func (ResizeReplicaSetResponse) GetBody added in v0.24.0 

func (r ResizeReplicaSetResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ResizeReplicaSetResponse) GetJSON4XX added in v0.24.0 

func (r ResizeReplicaSetResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (ResizeReplicaSetResponse) GetJSON202 added in v0.24.0 

func (r ResizeReplicaSetResponse) GetJSON202() *SuccessMessage

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (ResizeReplicaSetResponse) Status 

func (r ResizeReplicaSetResponse) Status() string

Status returns HTTPResponse.Status

func (ResizeReplicaSetResponse) StatusCode 

func (r ResizeReplicaSetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ResizeServiceJSONRequestBody 

type ResizeServiceJSONRequestBody = ResizeInput

ResizeServiceJSONRequestBody defines body for ResizeService for application/json ContentType.

type ResizeServiceResponse 

type ResizeServiceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *Service
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseResizeServiceResponse 

func ParseResizeServiceResponse(rsp *http.Response) (*ResizeServiceResponse, error)

ParseResizeServiceResponse parses an HTTP response from a ResizeServiceWithResponse call

func (ResizeServiceResponse) ContentType added in v0.24.0 

func (r ResizeServiceResponse) ContentType() string

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

func (ResizeServiceResponse) GetBody added in v0.24.0 

func (r ResizeServiceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ResizeServiceResponse) GetJSON4XX added in v0.24.0 

func (r ResizeServiceResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (ResizeServiceResponse) GetJSON202 added in v0.24.0 

func (r ResizeServiceResponse) GetJSON202() *Service

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (ResizeServiceResponse) Status 

func (r ResizeServiceResponse) Status() string

Status returns HTTPResponse.Status

func (ResizeServiceResponse) StatusCode 

func (r ResizeServiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Resource 

type Resource struct {
	// ID Resource identifier.
	//
	// Example: n4ph2tqz8r
	ID *string `json:"id,omitempty"`

	// Spec Resource specification.
	Spec *ResourceSpec `json:"spec,omitempty"`
}

Resource A resource allocated to the service.

type ResourceSpec 

type ResourceSpec struct {
	// CPUMillis CPU allocation in millicores.
	//
	// Example: 1000
	CPUMillis *int `json:"cpu_millis,omitempty"`

	// MemoryGbs Memory allocation in gigabytes.
	//
	// Example: 4
	MemoryGbs *int `json:"memory_gbs,omitempty"`

	// VolumeType Type of storage volume.
	//
	// Example: gp3
	VolumeType *string `json:"volume_type,omitempty"`
}

ResourceSpec Resource specification.

type Service 

type Service struct {
	// ConnectionPooler Connection pooler configuration for a service.
	ConnectionPooler *ConnectionPooler `json:"connection_pooler,omitempty"`

	// Created Creation timestamp.
	//
	// Example: 2025-01-15T09:30:00Z
	Created time.Time `json:"created"`

	// Endpoint A network endpoint for connecting to a service.
	Endpoint *Endpoint `json:"endpoint,omitempty"`

	// ForkedFrom The service this service was forked from.
	ForkedFrom *ForkSpec `json:"forked_from,omitempty"`

	// HaReplicas High-availability replica configuration for a service.
	HaReplicas *HAReplica `json:"ha_replicas,omitempty"`

	// InitialPassword The initial password for the service.
	//
	// Example: a-very-secure-initial-password
	InitialPassword *string `json:"initial_password,omitempty"`

	// Metadata Additional metadata for the service.
	Metadata *ServiceMetadata `json:"metadata,omitempty"`

	// Metrics Resource usage metrics for the service.
	Metrics *ServiceMetrics `json:"metrics,omitempty"`

	// Name The name of the service.
	//
	// Example: my-production-db
	Name string `json:"name"`

	// ProjectID The project this service belongs to.
	//
	// Example: rp1pz7uyae
	ProjectID string `json:"project_id"`

	// ReadReplicaSets The read replica sets attached to the service.
	ReadReplicaSets *[]ReadReplicaSet `json:"read_replica_sets,omitempty"`

	// RegionCode The cloud region where the service is hosted.
	//
	// Example: us-east-1
	RegionCode string `json:"region_code"`

	// Resources List of resources allocated to the service.
	Resources []Resource `json:"resources"`

	// ServiceID The unique identifier for the service.
	//
	// Example: kd9w2xp4mz
	ServiceID string `json:"service_id"`

	// ServiceType The type of the service.
	ServiceType ServiceType `json:"service_type"`

	// Status Current status of the service.
	Status DeployStatus `json:"status"`

	// VpcEndpointDeprecated Deprecated. Use `vpc_endpoint` instead.
	// Deprecated: Use `vpc_endpoint` instead.
	VpcEndpointDeprecated *VPCEndpoint `json:"vpcEndpoint,omitempty"`

	// VpcEndpoint VPC endpoint configuration if available.
	VpcEndpoint *VPCEndpoint `json:"vpc_endpoint,omitempty"`
}

Service A database service and its current configuration.

type ServiceCreate 

type ServiceCreate struct {
	// Addons List of addons to enable for the service. 'time-series' enables TimescaleDB, 'ai' enables AI/vector extensions.
	//
	// Example: ["time-series","ai"]
	Addons *[]ServiceCreateAddons `json:"addons,omitempty"`

	// CPUMillis The initial CPU allocation in milli-cores, or 'shared' for a shared-resource service.
	//
	// Example: 1000
	CPUMillis *string `json:"cpu_millis,omitempty"`

	// EnvironmentTag The environment tag for the service.
	EnvironmentTag *EnvironmentTag `json:"environment_tag,omitempty"`

	// MemoryGbs The initial memory allocation in gigabytes, or 'shared' for a shared-resource service.
	//
	// Example: 4
	MemoryGbs *string `json:"memory_gbs,omitempty"`

	// Name A human-readable name for the service.
	//
	// Example: my-production-db
	Name string `json:"name"`

	// RegionCode The region where the service will be created. If not provided, we'll choose the best region for you.
	//
	// Example: us-east-1
	RegionCode *string `json:"region_code,omitempty"`

	// ReplicaCount Number of high-availability replicas to create (all replicas are asynchronous by default).
	//
	// Example: 2
	ReplicaCount *int `json:"replica_count,omitempty"`
}

ServiceCreate Parameters for creating a service.

type ServiceCreateAddons 

type ServiceCreateAddons string

ServiceCreateAddons defines model for ServiceCreate.Addons. 

const (
	ServiceCreateAddonsAi         ServiceCreateAddons = "ai"
	ServiceCreateAddonsTimeSeries ServiceCreateAddons = "time-series"
)

Defines values for ServiceCreateAddons.

func (ServiceCreateAddons) Valid added in v0.24.0 

func (e ServiceCreateAddons) Valid() bool

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

type ServiceID 

type ServiceID = string

ServiceID Example: d1k5vk7hf2

type ServiceLogEntry 

type ServiceLogEntry struct {
	// Message Log message text.
	//
	// Example: database system is ready to accept connections
	Message string `json:"message"`

	// Severity PostgreSQL severity level (e.g. LOG, WARNING, ERROR, FATAL).
	//
	// Example: LOG
	Severity string `json:"severity"`

	// Timestamp Timestamp of the log entry (RFC3339 format).
	//
	// Example: 2025-01-15T09:30:00Z
	Timestamp time.Time `json:"timestamp"`
}

ServiceLogEntry A single structured log entry from a service.

type ServiceLogs 

type ServiceLogs struct {
	// Entries Structured log entries with timestamp and severity metadata.
	// Entries are in the same order as logs and can be used in place of it
	// by callers that need structured data.
	Entries *[]ServiceLogEntry `json:"entries,omitempty"`

	// LastCursorDeprecated Deprecated. Use `last_cursor` instead.
	//
	// Example: eyJ0cyI6IjIwMjUtMDEtMTVUMDk6MzA6MDBaIn0=
	// Deprecated: Use `last_cursor` instead.
	LastCursorDeprecated *string `json:"lastCursor,omitempty"`

	// LastCursor Opaque cursor for the next page of results. Present when more log entries
	// exist older than the last entry in this response. Pass this value as the
	// `cursor` query parameter to retrieve the next page. Absent when there are
	// no further results.
	//
	//
	// Example: eyJ0cyI6IjIwMjUtMDEtMTVUMDk6MzA6MDBaIn0=
	LastCursor *string `json:"last_cursor,omitempty"`

	// Logs Array of log message strings. Preserved for backwards compatibility.
	// Deprecated: Use `entries` instead.
	Logs []string `json:"logs"`
}

ServiceLogs The logs for a service.

type ServiceMetadata 

type ServiceMetadata struct {
	// Environment Environment tag for the service.
	//
	// Example: PROD
	Environment *string `json:"environment,omitempty"`
}

ServiceMetadata Additional metadata for the service.

type ServiceMetrics 

type ServiceMetrics struct {
	// MemoryMb Memory usage in megabytes.
	//
	// Example: 512
	MemoryMb *int `json:"memory_mb,omitempty"`

	// MilliCPU CPU usage in millicores.
	//
	// Example: 250
	MilliCPU *int `json:"milli_cpu,omitempty"`

	// StorageMb Storage usage in megabytes.
	//
	// Example: 1024
	StorageMb *int `json:"storage_mb,omitempty"`
}

ServiceMetrics Resource usage metrics for the service.

type ServiceRename 

type ServiceRename struct {
	// Name The new name for the service.
	//
	// Example: my-renamed-service
	Name string `json:"name"`
}

ServiceRename Parameters for renaming a service.

type ServiceType 

type ServiceType string

ServiceType The type of the service: - TIMESCALEDB: a TimescaleDB service (PostgreSQL with the TimescaleDB extension) - POSTGRES: a standard PostgreSQL service

VECTOR is deprecated and should not be used. 

const (
	ServiceTypePOSTGRES    ServiceType = "POSTGRES"
	ServiceTypeTIMESCALEDB ServiceType = "TIMESCALEDB"
	ServiceTypeVECTOR      ServiceType = "VECTOR"
)

Defines values for ServiceType.

func (ServiceType) Valid added in v0.24.0 

func (e ServiceType) Valid() bool

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

type ServiceVPCInput 

type ServiceVPCInput struct {
	// VpcID The ID of the VPC to attach the service to.
	//
	// Example: 1234567890
	VpcID string `json:"vpc_id"`
}

ServiceVPCInput Parameters for attaching a service to a VPC.

type SetEnvironmentInput 

type SetEnvironmentInput struct {
	// Environment The target environment for the service:
	// - PROD: a production environment
	// - DEV: a development environment
	Environment SetEnvironmentInputEnvironment `json:"environment"`
}

SetEnvironmentInput Parameters for setting a service's environment.

Example: {"environment":"PROD"}

type SetEnvironmentInputEnvironment 

type SetEnvironmentInputEnvironment string

SetEnvironmentInputEnvironment The target environment for the service: - PROD: a production environment - DEV: a development environment 

const (
	SetEnvironmentInputEnvironmentDEV  SetEnvironmentInputEnvironment = "DEV"
	SetEnvironmentInputEnvironmentPROD SetEnvironmentInputEnvironment = "PROD"
)

Defines values for SetEnvironmentInputEnvironment.

func (SetEnvironmentInputEnvironment) Valid added in v0.24.0 

func (e SetEnvironmentInputEnvironment) Valid() bool

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

type SetEnvironmentJSONRequestBody 

type SetEnvironmentJSONRequestBody = SetEnvironmentInput

SetEnvironmentJSONRequestBody defines body for SetEnvironment for application/json ContentType.

type SetEnvironmentResponse 

type SetEnvironmentResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SuccessMessage
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseSetEnvironmentResponse 

func ParseSetEnvironmentResponse(rsp *http.Response) (*SetEnvironmentResponse, error)

ParseSetEnvironmentResponse parses an HTTP response from a SetEnvironmentWithResponse call

func (SetEnvironmentResponse) ContentType added in v0.24.0 

func (r SetEnvironmentResponse) ContentType() string

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

func (SetEnvironmentResponse) GetBody added in v0.24.0 

func (r SetEnvironmentResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SetEnvironmentResponse) GetJSON4XX added in v0.24.0 

func (r SetEnvironmentResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (SetEnvironmentResponse) GetJSON200 added in v0.24.0 

func (r SetEnvironmentResponse) GetJSON200() *SuccessMessage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SetEnvironmentResponse) Status 

func (r SetEnvironmentResponse) Status() string

Status returns HTTPResponse.Status

func (SetEnvironmentResponse) StatusCode 

func (r SetEnvironmentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SetHAReplicaInput 

type SetHAReplicaInput struct {
	// ReplicaCount Number of high-availability replicas (all replicas are asynchronous by default).
	//
	// Example: 1
	ReplicaCount *int `json:"replica_count,omitempty"`

	// SyncReplicaCount Number of synchronous high-availability replicas.
	//
	// Example: 1
	SyncReplicaCount *int `json:"sync_replica_count,omitempty"`
}

SetHAReplicaInput At least one of sync_replica_count or replica_count must be provided.

type SetHAReplicaJSONRequestBody 

type SetHAReplicaJSONRequestBody = SetHAReplicaInput

SetHAReplicaJSONRequestBody defines body for SetHAReplica for application/json ContentType.

type SetHAReplicaResponse 

type SetHAReplicaResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *Service
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseSetHAReplicaResponse 

func ParseSetHAReplicaResponse(rsp *http.Response) (*SetHAReplicaResponse, error)

ParseSetHAReplicaResponse parses an HTTP response from a SetHAReplicaWithResponse call

func (SetHAReplicaResponse) ContentType added in v0.24.0 

func (r SetHAReplicaResponse) ContentType() string

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

func (SetHAReplicaResponse) GetBody added in v0.24.0 

func (r SetHAReplicaResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SetHAReplicaResponse) GetJSON4XX added in v0.24.0 

func (r SetHAReplicaResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (SetHAReplicaResponse) GetJSON202 added in v0.24.0 

func (r SetHAReplicaResponse) GetJSON202() *Service

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (SetHAReplicaResponse) Status 

func (r SetHAReplicaResponse) Status() string

Status returns HTTPResponse.Status

func (SetHAReplicaResponse) StatusCode 

func (r SetHAReplicaResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SetReplicaEnvironmentJSONRequestBody 

type SetReplicaEnvironmentJSONRequestBody = SetEnvironmentInput

SetReplicaEnvironmentJSONRequestBody defines body for SetReplicaEnvironment for application/json ContentType.

type SetReplicaEnvironmentResponse 

type SetReplicaEnvironmentResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SuccessMessage
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseSetReplicaEnvironmentResponse 

func ParseSetReplicaEnvironmentResponse(rsp *http.Response) (*SetReplicaEnvironmentResponse, error)

ParseSetReplicaEnvironmentResponse parses an HTTP response from a SetReplicaEnvironmentWithResponse call

func (SetReplicaEnvironmentResponse) ContentType added in v0.24.0 

func (r SetReplicaEnvironmentResponse) ContentType() string

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

func (SetReplicaEnvironmentResponse) GetBody added in v0.24.0 

func (r SetReplicaEnvironmentResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SetReplicaEnvironmentResponse) GetJSON4XX added in v0.24.0 

func (r SetReplicaEnvironmentResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (SetReplicaEnvironmentResponse) GetJSON200 added in v0.24.0 

func (r SetReplicaEnvironmentResponse) GetJSON200() *SuccessMessage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SetReplicaEnvironmentResponse) Status 

func (r SetReplicaEnvironmentResponse) Status() string

Status returns HTTPResponse.Status

func (SetReplicaEnvironmentResponse) StatusCode 

func (r SetReplicaEnvironmentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StartServiceResponse 

type StartServiceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *Service
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseStartServiceResponse 

func ParseStartServiceResponse(rsp *http.Response) (*StartServiceResponse, error)

ParseStartServiceResponse parses an HTTP response from a StartServiceWithResponse call

func (StartServiceResponse) ContentType added in v0.24.0 

func (r StartServiceResponse) ContentType() string

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

func (StartServiceResponse) GetBody added in v0.24.0 

func (r StartServiceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (StartServiceResponse) GetJSON4XX added in v0.24.0 

func (r StartServiceResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (StartServiceResponse) GetJSON202 added in v0.24.0 

func (r StartServiceResponse) GetJSON202() *Service

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (StartServiceResponse) Status 

func (r StartServiceResponse) Status() string

Status returns HTTPResponse.Status

func (StartServiceResponse) StatusCode 

func (r StartServiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StopServiceResponse 

type StopServiceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *Service
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseStopServiceResponse 

func ParseStopServiceResponse(rsp *http.Response) (*StopServiceResponse, error)

ParseStopServiceResponse parses an HTTP response from a StopServiceWithResponse call

func (StopServiceResponse) ContentType added in v0.24.0 

func (r StopServiceResponse) ContentType() string

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

func (StopServiceResponse) GetBody added in v0.24.0 

func (r StopServiceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (StopServiceResponse) GetJSON4XX added in v0.24.0 

func (r StopServiceResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (StopServiceResponse) GetJSON202 added in v0.24.0 

func (r StopServiceResponse) GetJSON202() *Service

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (StopServiceResponse) Status 

func (r StopServiceResponse) Status() string

Status returns HTTPResponse.Status

func (StopServiceResponse) StatusCode 

func (r StopServiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SuccessMessage 

type SuccessMessage struct {
	// Message Example: Action completed successfully.
	Message *string `json:"message,omitempty"`
}

SuccessMessage defines model for SuccessMessage.

type TrackEventJSONBody 

type TrackEventJSONBody struct {
	// Event The name of the event to track.
	//
	// Example: service_created
	Event string `json:"event"`

	// Properties Optional map of arbitrary properties associated with the event.
	//
	// Example: {"region":"us-east-1"}
	Properties *map[string]interface{} `json:"properties,omitempty"`
}

TrackEventJSONBody defines parameters for TrackEvent.

type TrackEventJSONRequestBody 

type TrackEventJSONRequestBody TrackEventJSONBody

TrackEventJSONRequestBody defines body for TrackEvent for application/json ContentType.

type TrackEventResponse 

type TrackEventResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AnalyticsResponse
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseTrackEventResponse 

func ParseTrackEventResponse(rsp *http.Response) (*TrackEventResponse, error)

ParseTrackEventResponse parses an HTTP response from a TrackEventWithResponse call

func (TrackEventResponse) ContentType added in v0.24.0 

func (r TrackEventResponse) ContentType() string

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

func (TrackEventResponse) GetBody added in v0.24.0 

func (r TrackEventResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (TrackEventResponse) GetJSON4XX added in v0.24.0 

func (r TrackEventResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (TrackEventResponse) GetJSON200 added in v0.24.0 

func (r TrackEventResponse) GetJSON200() *AnalyticsResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (TrackEventResponse) Status 

func (r TrackEventResponse) Status() string

Status returns HTTPResponse.Status

func (TrackEventResponse) StatusCode 

func (r TrackEventResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdatePasswordInput 

type UpdatePasswordInput struct {
	// Password The new password.
	//
	// Example: a-very-secure-new-password
	Password string `json:"password"`
}

UpdatePasswordInput Parameters for updating a service's password.

type UpdatePasswordJSONRequestBody 

type UpdatePasswordJSONRequestBody = UpdatePasswordInput

UpdatePasswordJSONRequestBody defines body for UpdatePassword for application/json ContentType.

type UpdatePasswordResponse 

type UpdatePasswordResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON4XX the response for an HTTP 4XX `application/json` response
	JSON4XX *ClientError
}

func ParseUpdatePasswordResponse 

func ParseUpdatePasswordResponse(rsp *http.Response) (*UpdatePasswordResponse, error)

ParseUpdatePasswordResponse parses an HTTP response from a UpdatePasswordWithResponse call

func (UpdatePasswordResponse) ContentType added in v0.24.0 

func (r UpdatePasswordResponse) ContentType() string

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

func (UpdatePasswordResponse) GetBody added in v0.24.0 

func (r UpdatePasswordResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdatePasswordResponse) GetJSON4XX added in v0.24.0 

func (r UpdatePasswordResponse) GetJSON4XX() *ClientError

GetJSON4XX returns the response for an HTTP 4XX `application/json` response

func (UpdatePasswordResponse) Status 

func (r UpdatePasswordResponse) Status() string

Status returns HTTPResponse.Status

func (UpdatePasswordResponse) StatusCode 

func (r UpdatePasswordResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type VPC 

type VPC struct {
	// Cidr The IPv4 CIDR block for the VPC, in address/prefix notation (e.g. 10.0.0.0/16).
	//
	// Example: 10.0.0.0/16
	Cidr string `json:"cidr"`

	// ID The unique identifier for the VPC.
	//
	// Example: 1234567890
	ID *string `json:"id,omitempty"`

	// Name The name of the VPC.
	//
	// Example: my-production-vpc
	Name string `json:"name"`

	// RegionCode The cloud region where the VPC is hosted.
	//
	// Example: us-east-1
	RegionCode string `json:"region_code"`
}

VPC A virtual private cloud that services can be attached to.

type VPCCreate 

type VPCCreate struct {
	// Cidr The IPv4 CIDR block for the VPC, in address/prefix notation (e.g. 10.0.0.0/16).
	//
	// Example: 10.0.0.0/16
	Cidr string `json:"cidr"`

	// Name The name of the VPC.
	//
	// Example: my-production-vpc
	Name string `json:"name"`

	// RegionCode The cloud region where the VPC will be created.
	//
	// Example: us-east-1
	RegionCode string `json:"region_code"`
}

VPCCreate Parameters for creating a VPC.

type VPCEndpoint 

type VPCEndpoint struct {
	// Host The hostname for connecting to the service over VPC peering.
	//
	// Example: i4wmp4crev.oec7sxsza2.tsdb.cloud.timescale.com
	Host *string `json:"host,omitempty"`

	// Port The port for connecting to the service over VPC peering.
	//
	// Example: 5432
	Port *int `json:"port,omitempty"`

	// VpcID The ID of the VPC the endpoint is associated with.
	//
	// Example: 1337
	VpcID *string `json:"vpc_id,omitempty"`
}

VPCEndpoint VPC endpoint configuration for connecting to a service over VPC peering.

type VPCId 

type VPCId = string

VPCId Example: 1234567890

type VPCRename 

type VPCRename struct {
	// Name The new name for the VPC.
	//
	// Example: my-renamed-vpc
	Name string `json:"name"`
}

VPCRename Parameters for renaming a VPC.

Source Files

View all Source files

Directories

Path Synopsis
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.