api

Documentation

Index

• Constants
• Variables
• type API
  • func BuildAPI(meta any) *API
  • func NewAPI(ba_bearer_token, ba_api_uri, userAgent string) *API
  • func (api *API) ClusterClient() *ClusterClient
  • func (api *API) RegionClient() *RegionClient
• type APIError
• type BigAnimalError
  • func (baerr *BigAnimalError) Error() string
  • func (baerr *BigAnimalError) GetDetails() string
• type ClusterClient
  • func NewClusterClient(api API) *ClusterClient
  • func (c ClusterClient) ConnectionString(ctx context.Context, id string) (*models.ClusterConnection, error)
  • func (c ClusterClient) Create(ctx context.Context, model any) (string, error)
  • func (c ClusterClient) Delete(ctx context.Context, id string) error
  • func (c ClusterClient) Read(ctx context.Context, id string) (*models.Cluster, error)
  • func (c ClusterClient) ReadByName(ctx context.Context, name string) (*models.Cluster, error)
  • func (c ClusterClient) Update(ctx context.Context, cluster *models.Cluster, id string) (*models.Cluster, error)
• type ClusterResponse
• type ErrorMessage
• type RegionClient
  • func NewRegionClient(api API) *RegionClient
  • func (c RegionClient) Create(ctx context.Context, model any) (string, error)
  • func (c RegionClient) List(ctx context.Context, csp_id, query string) ([]*models.Region, error)
  • func (c RegionClient) Read(ctx context.Context, csp_id, id string) (*models.Region, error)
  • func (c RegionClient) Update(ctx context.Context, action, csp_id, region_id string) error

Constants

const (
	REGION_ACTIVE    = "ACTIVE"
	REGION_INACTIVE  = "INACTIVE"
	REGION_SUSPENDED = "SUSPENDED"
)

Variables

var (
	Error404     = errors.New("resource not found")
	ErrorUnknown = errors.New("unknown API error")
)

Types

type API

type API struct {
	BaseURL    string
	Token      string
	UserAgent  string
	HTTPClient http.Client
}

func BuildAPI

func BuildAPI(meta any) *API

func NewAPI

func NewAPI(ba_bearer_token, ba_api_uri, userAgent string) *API

func (*API) ClusterClient

func (api *API) ClusterClient() *ClusterClient

func (*API) RegionClient

func (api *API) RegionClient() *RegionClient

type APIError

type APIError struct {
	Error struct {
		Status    int            `json:"status"`
		Message   string         `json:"message"`
		Errors    []ErrorMessage `json:"errors"`
		Reference string         `json:"reference"`
		Source    string         `json:"source"`
	} `json:"error"`
}

type BigAnimalError

type BigAnimalError struct {
	APIError APIError
}

func (*BigAnimalError) Error

func (baerr *BigAnimalError) Error() string

func (*BigAnimalError) GetDetails

func (baerr *BigAnimalError) GetDetails() string

type ClusterClient

type ClusterClient struct{ API }

func NewClusterClient

func NewClusterClient(api API) *ClusterClient

func (ClusterClient) ConnectionString

func (c ClusterClient) ConnectionString(ctx context.Context, id string) (*models.ClusterConnection, error)

func (ClusterClient) Create

func (c ClusterClient) Create(ctx context.Context, model any) (string, error)

func (ClusterClient) Delete

func (c ClusterClient) Delete(ctx context.Context, id string) error

func (ClusterClient) Read

func (c ClusterClient) Read(ctx context.Context, id string) (*models.Cluster, error)

func (ClusterClient) ReadByName

func (c ClusterClient) ReadByName(ctx context.Context, name string) (*models.Cluster, error)

func (ClusterClient) Update

func (c ClusterClient) Update(ctx context.Context, cluster *models.Cluster, id string) (*models.Cluster, error)

type ClusterResponse

type ClusterResponse struct {
	Data struct {
		ClusterId string `json:"clusterId"`
	} `json:"data"`
}

type ErrorMessage

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

type RegionClient

type RegionClient struct{ API }

func NewRegionClient

func NewRegionClient(api API) *RegionClient

func (RegionClient) Create

func (c RegionClient) Create(ctx context.Context, model any) (string, error)

func (RegionClient) List

func (c RegionClient) List(ctx context.Context, csp_id, query string) ([]*models.Region, error)

func (RegionClient) Read

func (c RegionClient) Read(ctx context.Context, csp_id, id string) (*models.Region, error)

func (RegionClient) Update

func (c RegionClient) Update(ctx context.Context, action, csp_id, region_id string) error