client

package
v1.15.0 Latest Latest
Warning

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

 Go to latest Published: Feb 21, 2025 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	//go:embed queries/create_service.graphql
	CreateServiceMutation string
	//go:embed queries/rename_service.graphql
	RenameServiceMutation string
	//go:embed queries/resize_instance.graphql
	ResizeInstanceMutation string
	//go:embed queries/delete_service.graphql
	DeleteServiceMutation string
	//go:embed queries/toggle_service.graphql
	ToggleServiceMutation string
	//go:embed queries/toggle_connection_pooler.graphql
	ToggleConnectionPoolerMutation string
	//go:embed queries/set_env_tag.graphql
	SetEnvironmentTagMutation string
	//go:embed queries/get_all_services.graphql
	GetAllServicesQuery string
	//go:embed queries/get_service.graphql
	GetServiceQuery string
	//go:embed queries/products.graphql
	ProductsQuery string
	//go:embed queries/jwt_cc.graphql
	JWTFromCCQuery string
	//go:embed queries/set_replica_count.graphql
	SetReplicaCountMutation string
	//go:embed queries/change_service_password.graphql
	ResetServicePassword string

	// VCPs ///////////////////////////////
	//go:embed queries/vpcs.graphql
	GetVPCsQuery string
	//go:embed queries/vpc_by_name.graphql
	GetVPCByNameQuery string
	//go:embed queries/vpc_by_id.graphql
	GetVPCByIDQuery string
	//go:embed queries/attach_service_to_vpc.graphql
	AttachServiceToVPCMutation string
	//go:embed queries/detach_service_from_vpc.graphql
	DetachServiceFromVPCMutation string
	//go:embed queries/create_vpc.graphql
	CreateVPCMutation string
	//go:embed queries/delete_vpc.graphql
	DeleteVPCMutation string
	//go:embed queries/rename_vpc.graphql
	RenameVPCMutation string
	//go:embed queries/open_peer_request.graphql
	OpenPeerRequestMutation string
	//go:embed queries/delete_peer_request.graphql
	DeletePeeringConnectionMutation string
)

Functions

func JWTFromCC 

func JWTFromCC(c *Client, accessKey, secretKey string) error

Types

type Client 

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

func NewClient 

func NewClient(token, projectID, env, terraformVersion string) *Client

func (*Client) AttachServiceToVPC added in v1.3.0 

func (c *Client) AttachServiceToVPC(ctx context.Context, serviceID string, vpcID int64) error

func (*Client) CreateService 

func (c *Client) CreateService(ctx context.Context, request CreateServiceRequest) (*CreateServiceResponse, error)

func (*Client) CreateVPC added in v1.3.0 

func (c *Client) CreateVPC(ctx context.Context, name, cidr, regionCode string) (*VPC, error)

func (*Client) DeletePeeringConnection added in v1.6.0 

func (c *Client) DeletePeeringConnection(ctx context.Context, vpcID, id int64) error

func (*Client) DeleteService 

func (c *Client) DeleteService(ctx context.Context, id string) (*Service, error)

func (*Client) DeleteVPC added in v1.3.0 

func (c *Client) DeleteVPC(ctx context.Context, vpcID int64) error

func (*Client) DetachServiceFromVPC added in v1.3.0 

func (c *Client) DetachServiceFromVPC(ctx context.Context, serviceID string, vpcID int64) error

func (*Client) GetAllServices added in v1.2.0 

func (c *Client) GetAllServices(ctx context.Context) ([]*Service, error)

func (*Client) GetProducts 

func (c *Client) GetProducts(ctx context.Context) ([]*Product, error)

func (*Client) GetService 

func (c *Client) GetService(ctx context.Context, id string) (*Service, error)

func (*Client) GetVPCByID added in v1.3.0 

func (c *Client) GetVPCByID(ctx context.Context, vpcID int64) (*VPC, error)

func (*Client) GetVPCByName added in v1.3.0 

func (c *Client) GetVPCByName(ctx context.Context, name string) (*VPC, error)

func (*Client) GetVPCs added in v0.2.1 

func (c *Client) GetVPCs(ctx context.Context) ([]*VPC, error)

func (*Client) OpenPeerRequest added in v1.6.0 

func (c *Client) OpenPeerRequest(ctx context.Context, vpcID int64, externalVpcID, accountID, regionCode string) error

func (*Client) RenameService 

func (c *Client) RenameService(ctx context.Context, serviceID string, newName string) error

func (*Client) RenameVPC added in v1.3.0 

func (c *Client) RenameVPC(ctx context.Context, vpcID int64, newName string) error

func (*Client) ResetServicePassword added in v1.12.0 

func (c *Client) ResetServicePassword(ctx context.Context, serviceID string, password string) error

func (*Client) ResizeInstance 

func (c *Client) ResizeInstance(ctx context.Context, serviceID string, config ResourceConfig) error

func (*Client) SetEnvironmentTag added in v1.11.0 

func (c *Client) SetEnvironmentTag(ctx context.Context, serviceID, environment string) error

func (*Client) SetReplicaCount added in v0.3.2 

func (c *Client) SetReplicaCount(ctx context.Context, serviceID string, replicaCount int) error

func (*Client) ToggleConnectionPooler added in v1.4.0 

func (c *Client) ToggleConnectionPooler(ctx context.Context, serviceID string, enable bool) error

func (*Client) ToggleService added in v1.8.0 

func (c *Client) ToggleService(ctx context.Context, id, status string) (*Service, error)

type CreateServiceRequest 

type CreateServiceRequest struct {
	Name     string
	MilliCPU string
	MemoryGB string
	// StorageGB is used for forks, since the CreateServiceRequest expects a storage to be requested
	// and the fork instance should match the storage size of the primary.
	StorageGB    string
	RegionCode   string
	ReplicaCount string
	VpcID        int64
	ForkConfig   *ForkConfig

	EnableConnectionPooler bool
	EnvironmentTag         string
}

type CreateServiceResponse 

type CreateServiceResponse struct {
	Service         Service `json:"service"`
	InitialPassword string  `json:"initialPassword"`
}

type CreateServiceResponseData 

type CreateServiceResponseData struct {
	CreateServiceResponse CreateServiceResponse `json:"createService"`
}

type CreateVPCResponse added in v1.3.0 

type CreateVPCResponse struct {
	VPC *VPC `json:"createVPC"`
}

type DeleteServiceResponse 

type DeleteServiceResponse struct {
	Service Service `json:"deleteService"`
}

type EndpointAddress added in v1.11.1 

type EndpointAddress struct {
	// The hostname to use for connections.
	Host string `json:"host"`
	// The port to use for connections.
	Port int `json:"port"`
}

EndpointAddress represents the endpoint address

type Error 

type Error struct {
	Message string `json:"message"`
}

func (*Error) Error 

func (e *Error) Error() string

type ForkConfig added in v1.2.0 

type ForkConfig struct {
	ProjectID string `json:"projectID"`
	ServiceID string `json:"serviceID"`
	IsStandby bool   `json:"isStandby"`
}

type ForkSpec added in v1.2.0 

type ForkSpec struct {
	ProjectID string `json:"projectId"`
	ServiceID string `json:"serviceId"`
	IsStandby bool   `json:"isStandby"`
}

type GetAllServicesResponse added in v1.2.0 

type GetAllServicesResponse struct {
	Services []*Service `json:"getAllServices"`
}

type GetServiceResponse 

type GetServiceResponse struct {
	Service Service `json:"getService"`
}

type JWTFromCCResponse 

type JWTFromCCResponse struct {
	Token string `json:"getJWTForClientCredentials"`
}

type Metadata added in v1.11.0 

type Metadata struct {
	Environment string `json:"environment"`
}

type PeerVPC added in v1.3.0 

type PeerVPC struct {
	ID         string `json:"id"`
	CIDR       string `json:"cidr"`
	AccountID  string `json:"accountId"`
	RegionCode string `json:"regionCode"`
}

type PeeringConnection added in v0.2.1 

type PeeringConnection struct {
	ID            string   `json:"id"`
	VPCID         string   `json:"vpcId"`
	ProvisionedID string   `json:"provisionedId"`
	Status        string   `json:"status"`
	ErrorMessage  string   `json:"errorMessage"`
	PeerVPC       *PeerVPC `json:"peerVPC"`
}

type Plan 

type Plan struct {
	ProductID  string  `json:"productId"`
	RegionCode string  `json:"regionCode"`
	Price      float64 `json:"price"`
	MilliCPU   int64   `json:"milliCPU"`
	MemoryGB   int64   `json:"memoryGB"`
	StorageGB  int64   `json:"storageGB"`
}

type Product 

type Product struct {
	ID          string  `json:"id"`
	Name        string  `json:"name"`
	Description string  `json:"description"`
	Plans       []*Plan `json:"plans"`
}

type ProductsResponse 

type ProductsResponse struct {
	Products []*Product `json:"orbProducts"`
}

type ResourceConfig 

type ResourceConfig struct {
	MilliCPU     string
	MemoryGB     string
	ReplicaCount string
}

type ResourceSpec 

type ResourceSpec struct {
	ID   string `json:"id"`
	Spec struct {
		MilliCPU  int64 `json:"milliCPU"`
		MemoryGB  int64 `json:"memoryGB"`
		StorageGB int64 `json:"storageGB"`
	} `json:"spec"`
}

type Response 

type Response[T any] struct {
	Data   *T       `json:"data"`
	Errors []*Error `json:"errors"`
}

type Service 

type Service struct {
	ID            string         `json:"id"`
	ProjectID     string         `json:"projectId"`
	Name          string         `json:"name"`
	Status        string         `json:"status"`
	RegionCode    string         `json:"regionCode"`
	Paused        bool           `json:"paused"`
	ServiceSpec   ServiceSpec    `json:"spec"`
	Resources     []ResourceSpec `json:"resources"`
	Created       string         `json:"created"`
	ReplicaStatus string         `json:"replicaStatus"`
	VPCEndpoint   *VPCEndpoint   `json:"vpcEndpoint"`
	ForkSpec      *ForkSpec      `json:"forkedFromId"`
	Metadata      *Metadata      `json:"metadata"`

	// Endpoints contains the all service endpoints
	Endpoints *ServiceEndpoints `json:"endpoints,omitempty"`
}

type ServiceEndpoints added in v1.11.1 

type ServiceEndpoints struct {
	Primary *EndpointAddress `json:"primary"`
	Replica *EndpointAddress `json:"replica"`
	Pooler  *EndpointAddress `json:"pooler"`
}

ServiceEndpoints represents all service endpoints

type ServiceSpec 

type ServiceSpec struct {
	Hostname       string `json:"hostname"`
	Username       string `json:"username"`
	Port           int64  `json:"port"`
	PoolerHostname string `json:"poolerHostName"`
	PoolerPort     int64  `json:"poolerPort"`
	PoolerEnabled  bool   `json:"connectionPoolerEnabled"`
}

type ToggleServiceResponse added in v1.8.0 

type ToggleServiceResponse struct {
	Service Service `json:"toggleService"`
}

type VPC added in v0.2.1 

type VPC struct {
	ID                 string               `json:"id"`
	ProvisionedID      string               `json:"provisionedId"`
	ProjectID          string               `json:"projectId"`
	CIDR               string               `json:"cidr"`
	Name               string               `json:"name"`
	RegionCode         string               `json:"regionCode"`
	Status             string               `json:"status"`
	ErrorMessage       string               `json:"errorMessage"`
	Created            string               `json:"created"`
	Updated            string               `json:"updated"`
	PeeringConnections []*PeeringConnection `json:"peeringConnections"`
}

type VPCEndpoint added in v1.3.0 

type VPCEndpoint struct {
	Host  string `json:"host"`
	Port  int64  `json:"port"`
	VPCId string `json:"vpcId"`
}

type VPCNameResponse added in v1.6.0 

type VPCNameResponse struct {
	VPC *VPC `json:"getVPCByName"`
}

type VPCResponse added in v1.3.0 

type VPCResponse struct {
	VPC *VPC `json:"getVPC"`
}

type VPCsResponse added in v1.3.0 

type VPCsResponse struct {
	VPCs []*VPC `json:"getAllVPCs"`
}

Source Files

View all Source files

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.