transport

Documentation

Index

• Constants
• type Client
  • func NewClient(config *proxy.TLSConfig) (*Client, error)
  • func NewClientWithDefaultTransport() *Client
  • func (c *Client) Create(url string, request Request, response Response) error
  • func (c *Client) Delete(url string) error
  • func (c *Client) Do(request *http.Request) (*http.Response, error)
  • func (c *Client) Get(url string, response Response) error
  • func (c *Client) Patch(url string, request Request, response Response) error
  • func (c *Client) Update(url string, request Request, response Response) error
• type Config
  • func DefaultTransportConfig() *Config
  • func (cfg *Config) AddHeaders(header http.Header) *Config
  • func (cfg *Config) WithBasePath(basePath string) *Config
  • func (cfg *Config) WithHost(host string) *Config
  • func (cfg *Config) WithRefreshAuthCtx(refresh func() (map[string]string, error)) *Config
• type Request
• type Response

Constants

const (
	// DefaultHost is the default Host.
	DefaultHost string = "https://<your_org>.tmc.cloud.vmware.com"
	// DefaultBasePath is the default BasePath.
	DefaultBasePath string = "/"
)

Types

type Client

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

Client is the http client implementation.

func NewClient

func NewClient(config *proxy.TLSConfig) (*Client, error)

NewClient returns a new instance of http Client.

func NewClientWithDefaultTransport

func NewClientWithDefaultTransport() *Client

NewClientWithDefaultTransport is intended primarily for testing, as httpmock requires a default transport object be used.

func (*Client) Create

func (c *Client) Create(url string, request Request, response Response) error

func (*Client) Delete

func (c *Client) Delete(url string) error

func (*Client) Do

func (c *Client) Do(request *http.Request) (*http.Response, error)

Do makes an HTTP request with the native `http.Do` interface.

func (*Client) Get

func (c *Client) Get(url string, response Response) error

func (*Client) Patch

func (c *Client) Patch(url string, request Request, response Response) error

func (*Client) Update

func (c *Client) Update(url string, request Request, response Response) error

type Config

type Config struct {
	Host           string
	BasePath       string
	Headers        http.Header
	RefreshAuthCtx func() (map[string]string, error)
}

Config contains the transport related info.

func DefaultTransportConfig

func DefaultTransportConfig() *Config

DefaultTransportConfig creates a Config with default values.

func (*Config) AddHeaders

func (cfg *Config) AddHeaders(header http.Header) *Config

WithHeader overrides the default header.

func (*Config) WithBasePath

func (cfg *Config) WithBasePath(basePath string) *Config

WithBasePath overrides the default basePath.

func (*Config) WithHost

func (cfg *Config) WithHost(host string) *Config

WithHost overrides the default host.

func (*Config) WithRefreshAuthCtx

func (cfg *Config) WithRefreshAuthCtx(refresh func() (map[string]string, error)) *Config

WithRefreshAuthCtx overrides the default RefreshAuthCtx.

type Request

type Request interface {
	MarshalBinary() ([]byte, error)
}

type Response

type Response interface {
	UnmarshalBinary(b []byte) error
}