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 GetRunnerApiClient(apiUrl, apiKey, clientId string, telemetryEnabled bool) (*apiclient.APIClient, error)
• func GetTarget(targetNameOrId string) (*apiclient.TargetDTO, int, error)
• func GetWorkspace(workspaceNameOrId string) (*apiclient.WorkspaceDTO, int, error)
• func HandleErrorResponse(res *http.Response, requestErr error) error
• func IsHealthCheckFailed(err error) bool
• 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 GetRunnerApiClient

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

func GetTarget

func GetTarget(targetNameOrId string) (*apiclient.TargetDTO, int, error)

func GetWorkspace

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

func HandleErrorResponse

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

func IsHealthCheckFailed

func IsHealthCheckFailed(err error) bool

Types

type ApiErrorResponse

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