api

Documentation

Index

• func HandleHTTPError(resp *http.Response) error
• func NewCachedClient(httpClient *http.Client, cacheTTL time.Duration) *http.Client
• func NewHTTPClient(opts ...ClientOption) *http.Client
• type Client
  • func NewClient(opts ...ClientOption) *Client
  • func NewClientFromHTTP(httpClient *http.Client) *Client
  • func (c *Client) HTTP() *http.Client
  • func (c Client) REST(hostname string, method string, p string, body io.Reader, data interface{}) error
• type ClientOption
  • func AddHeader(name, value string) ClientOption
  • func AddHeaderFunc(name string, getValue func(*http.Request) (string, error)) ClientOption
  • func CacheResponse(ttl time.Duration, dir string) ClientOption
  • func ReplaceTripper(tr http.RoundTripper) ClientOption
  • func VerboseLog(out io.Writer, logTraffic bool, colorize bool) ClientOption
• type HTTPError
  • func (err HTTPError) Error() string
• type HTTPErrorItem

Functions

func HandleHTTPError

func HandleHTTPError(resp *http.Response) error

func NewCachedClient

func NewCachedClient(httpClient *http.Client, cacheTTL time.Duration) *http.Client

func NewHTTPClient

func NewHTTPClient(opts ...ClientOption) *http.Client

NewHTTPClient initializes an http.Client

Types

type Client

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

Client facilitates making HTTP requests to the Instill API

func NewClient

func NewClient(opts ...ClientOption) *Client

NewClient initializes a Client

func NewClientFromHTTP

func NewClientFromHTTP(httpClient *http.Client) *Client

NewClientFromHTTP takes in an http.Client instance

func (*Client) HTTP

func (c *Client) HTTP() *http.Client

func (Client) REST

func (c Client) REST(hostname string, method string, p string, body io.Reader, data interface{}) error

REST performs a REST request and parses the response.

type ClientOption

type ClientOption = func(http.RoundTripper) http.RoundTripper

ClientOption represents an argument to NewClient

func AddHeader

func AddHeader(name, value string) ClientOption

AddHeader turns a RoundTripper into one that adds a request header

func AddHeaderFunc

func AddHeaderFunc(name string, getValue func(*http.Request) (string, error)) ClientOption

AddHeaderFunc is an AddHeader that gets the string value from a function

func CacheResponse

func CacheResponse(ttl time.Duration, dir string) ClientOption

CacheResponse produces a RoundTripper that caches HTTP responses to disk for a specified amount of time

func ReplaceTripper

func ReplaceTripper(tr http.RoundTripper) ClientOption

ReplaceTripper substitutes the underlying RoundTripper with a custom one

func VerboseLog

func VerboseLog(out io.Writer, logTraffic bool, colorize bool) ClientOption

VerboseLog enables request/response logging within a RoundTripper

type HTTPError

type HTTPError struct {
	StatusCode int
	RequestURL *url.URL
	Message    string
	Errors     []HTTPErrorItem
}

HTTPError is an error returned by a failed API call

func (HTTPError) Error

func (err HTTPError) Error() string

type HTTPErrorItem

type HTTPErrorItem struct {
	Message  string
	Resource string
	Field    string
	Code     string
}