api

package
v0.30.4 Latest Latest
Warning

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

Go to latest
Published: Feb 24, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

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

Client handles Control Plane API operations

func NewClient

func NewClient(httpDoer http.HTTPDoer) *Client

NewClient creates a new API client

func (*Client) CreateDataplane

func (c *Client) CreateDataplane(ctx context.Context, req CreateDataplaneRequest) (*CreateDataplaneResponse, error)

CreateDataplane creates a new dataplane

func (*Client) CreateRegion added in v0.30.4

func (c *Client) CreateRegion(ctx context.Context, request CreateRegionRequest) (*Region, error)

CreateRegion creates a new region

func (*Client) DeleteDataplane

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

DeleteDataplane deletes a dataplane by ID

func (*Client) GetDataplane

func (c *Client) GetDataplane(ctx context.Context, id string) (*Dataplane, error)

GetDataplane retrieves a specific dataplane by ID

func (*Client) GetOrganization added in v0.30.4

func (c *Client) GetOrganization(ctx context.Context, organizationID string) (*Organization, error)

GetOrganization retrieves a specific organization by ID

func (*Client) GetRegion added in v0.30.4

func (c *Client) GetRegion(ctx context.Context, regionID string) (*Region, error)

GetRegion retrieves a specific region by ID

func (*Client) ListDataplanes

func (c *Client) ListDataplanes(ctx context.Context) ([]Dataplane, error)

ListDataplanes retrieves all dataplanes

func (*Client) ListOrganizations added in v0.30.4

func (c *Client) ListOrganizations(ctx context.Context) ([]*Organization, error)

ListOrganizations retrieves organizations for the authenticated user

func (*Client) ListRegions added in v0.30.4

func (c *Client) ListRegions(ctx context.Context, organizationID string) ([]*Region, error)

ListRegions retrieves all regions for an organization

type CreateDataplaneRequest added in v0.30.4

type CreateDataplaneRequest struct {
	Name           string `json:"name"`
	RegionID       string `json:"regionId"`
	OrganizationID string `json:"organizationId"`
	Enabled        bool   `json:"enabled"`
}

CreateDataplaneRequest represents the input for creating a new dataplane

type CreateDataplaneResponse added in v0.30.4

type CreateDataplaneResponse struct {
	DataplaneID  string `json:"dataplaneId"`
	RegionID     string `json:"regionId"`
	ClientID     string `json:"clientId"`
	ClientSecret string `json:"clientSecret"`
}

CreateDataplaneResponse represents the response from creating a dataplane

type CreateRegionRequest added in v0.30.4

type CreateRegionRequest struct {
	Name           string `json:"name"`
	OrganizationID string `json:"organizationId"`
	CloudProvider  string `json:"cloudProvider,omitempty"`
	Location       string `json:"location,omitempty"`
}

CreateRegionRequest represents the request to create a new region

type Dataplane

type Dataplane struct {
	DataplaneID string `json:"dataplaneId" yaml:"dataplaneId"`
	Name        string `json:"name" yaml:"name"`
	RegionID    string `json:"regionId" yaml:"regionId"`
	Enabled     bool   `json:"enabled" yaml:"enabled"`
}

Dataplane represents a dataplane resource for GET/LIST operations

type Organization added in v0.30.4

type Organization struct {
	ID    string `json:"organizationId"`
	Name  string `json:"organizationName"`
	Email string `json:"email"`
}

Organization represents an Airbyte organization

type Region added in v0.30.4

type Region struct {
	ID            string `json:"regionId"`
	Name          string `json:"name"`
	CloudProvider string `json:"cloudProvider,omitempty"`
	Location      string `json:"location,omitempty"`
	Status        string `json:"status,omitempty"`
}

Region represents an Airbyte region

type RegionsResponse added in v0.30.4

type RegionsResponse struct {
	Regions []Region `json:"regions"`
}

RegionsResponse represents the response from listing regions

type Service added in v0.30.4

type Service interface {
	// Organizations
	GetOrganization(ctx context.Context, organizationID string) (*Organization, error)
	ListOrganizations(ctx context.Context) ([]*Organization, error)

	// Regions
	CreateRegion(ctx context.Context, request CreateRegionRequest) (*Region, error)
	GetRegion(ctx context.Context, regionID string) (*Region, error)
	ListRegions(ctx context.Context, organizationID string) ([]*Region, error)

	// Dataplanes
	GetDataplane(ctx context.Context, id string) (*Dataplane, error)
	ListDataplanes(ctx context.Context) ([]Dataplane, error)
	CreateDataplane(ctx context.Context, req CreateDataplaneRequest) (*CreateDataplaneResponse, error)
	DeleteDataplane(ctx context.Context, id string) error
}

Service interface for Control Plane API operations

type UpdateDataplaneRequest added in v0.30.4

type UpdateDataplaneRequest struct {
	Name     string `json:"name"`
	RegionID string `json:"regionId"`
	Enabled  bool   `json:"enabled"`
}

UpdateDataplaneRequest represents the input for dataplane update operations

Directories

Path Synopsis
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.

Jump to

Keyboard shortcuts

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