apiclient

Documentation

Index

• Constants
• func ErrHealthCheckFailed(healthUrl string) error
• func GetAgentApiClient(apiUrl, apiKey, clientId string, telemetryEnabled bool) (*apiclient.APIClient, error)
• func GetApiClient(profile *config.Profile) (*apiclient.APIClient, error)
• func GetFirstWorkspaceProjectName(workspaceId string, projectName string, profile *config.Profile) (string, error)
• func GetWebSocketUrl(apiUrl string) (string, error)
• func GetWebsocketConn(ctx context.Context, path string, profile *config.Profile, query *string) (*websocket.Conn, *http.Response, error)
• func GetWorkspace(workspaceNameOrId string, verbose bool) (*apiclient.WorkspaceDTO, error)
• func HandleErrorResponse(res *http.Response, requestErr error) error
• func IsHealthCheckFailed(err error) bool
• func ReadBuildLogs(ctx context.Context, activeProfile config.Profile, buildId string, ...)
• func ReadWorkspaceLogs(ctx context.Context, activeProfile config.Profile, workspaceId string, ...)
• type ApiErrorResponse

Constants

const CLIENT_VERSION_HEADER = "X-Client-Version"

Functions

func ErrHealthCheckFailed

func ErrHealthCheckFailed(healthUrl string) error

func GetAgentApiClient

func GetAgentApiClient(apiUrl, apiKey, clientId string, telemetryEnabled bool) (*apiclient.APIClient, error)

func GetApiClient

func GetApiClient(profile *config.Profile) (*apiclient.APIClient, error)

func GetFirstWorkspaceProjectName

func GetFirstWorkspaceProjectName(workspaceId string, projectName string, profile *config.Profile) (string, error)

func GetWebSocketUrl

func GetWebSocketUrl(apiUrl string) (string, error)

func GetWebsocketConn

func GetWebsocketConn(ctx context.Context, path string, profile *config.Profile, query *string) (*websocket.Conn, *http.Response, error)

func GetWorkspace

func GetWorkspace(workspaceNameOrId string, verbose bool) (*apiclient.WorkspaceDTO, error)

func HandleErrorResponse

func HandleErrorResponse(res *http.Response, requestErr error) error

func IsHealthCheckFailed

func IsHealthCheckFailed(err error) bool

func ReadBuildLogs

func ReadBuildLogs(ctx context.Context, activeProfile config.Profile, buildId string, query string)

func ReadWorkspaceLogs

func ReadWorkspaceLogs(ctx context.Context, activeProfile config.Profile, workspaceId string, projectNames []string, follow, showWorkspaceLogs bool, from *time.Time)

Types

type ApiErrorResponse

type ApiErrorResponse struct {
	Error string `json:"error"`
}