client

Documentation

Overview

Package client is the API message for Bytebase API client.

Index

• func CheckServerHealth(reqURL string) error
• func NewClient(bb *bbv1.Bytebase, url, version, email, password string) (api.Client, error)
• type Client
  • func (c *Client) CreateEnvironment(ctx context.Context, environmentID string, create *api.EnvironmentMessage) (*api.EnvironmentMessage, error)
  • func (c *Client) CreateInstance(ctx context.Context, environmentID, instanceID string, ...) (*api.InstanceMessage, error)
  • func (c *Client) GetEnvironment(ctx context.Context, environmentID string) (*api.EnvironmentMessage, error)
  • func (c *Client) GetInstance(ctx context.Context, find *api.InstanceFindMessage) (*api.InstanceMessage, error)
  • func (c *Client) GetLoginCookie() api.LoginCookie
  • func (c *Client) Login(auth *api.AuthRequest) (int, error)
  • func (c *Client) Signup(cur *api.CreateUserRequest) (int, error)

Functions

func CheckServerHealth

func CheckServerHealth(reqURL string) error

func NewClient

func NewClient(bb *bbv1.Bytebase, url, version, email, password string) (api.Client, error)

NewClient returns the new Bytebase API client.

Types

type Client

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

client is the API message for Bytebase API client.

func (*Client) CreateEnvironment

func (c *Client) CreateEnvironment(ctx context.Context, environmentID string, create *api.EnvironmentMessage) (*api.EnvironmentMessage, error)

CreateEnvironment creates the environment.

func (*Client) CreateInstance

func (c *Client) CreateInstance(ctx context.Context, environmentID, instanceID string, instance *api.InstanceMessage) (*api.InstanceMessage, error)

CreateInstance creates the instance.

func (*Client) GetEnvironment

func (c *Client) GetEnvironment(ctx context.Context, environmentID string) (*api.EnvironmentMessage, error)

GetEnvironment gets the environment by id.

func (*Client) GetInstance

func (c *Client) GetInstance(ctx context.Context, find *api.InstanceFindMessage) (*api.InstanceMessage, error)

GetInstance gets the instance by id.

func (*Client) GetLoginCookie

func (c *Client) GetLoginCookie() api.LoginCookie

func (*Client) Login

func (c *Client) Login(auth *api.AuthRequest) (int, error)

Login will login the user and get the response.

func (*Client) Signup

func (c *Client) Signup(cur *api.CreateUserRequest) (int, error)