pdnshttp

Documentation

Index

• func IsNotFound(err error) bool
• type APIKeyAuthenticator
  • func (a *APIKeyAuthenticator) OnConnect(*http.Client) error
  • func (a *APIKeyAuthenticator) OnRequest(r *http.Request) error
• type BasicAuthenticator
  • func (a *BasicAuthenticator) OnConnect(*http.Client) error
  • func (a *BasicAuthenticator) OnRequest(r *http.Request) error
• type Client
  • func NewClient(baseURL string, hc *http.Client, auth ClientAuthenticator, ...) *Client
  • func (c *Client) Delete(ctx context.Context, path string, out interface{}, opts ...RequestOption) error
  • func (c *Client) Do(ctx context.Context, req *http.Request, out interface{}) error
  • func (c *Client) Get(ctx context.Context, path string, out interface{}, opts ...RequestOption) error
  • func (c *Client) NewRequest(method string, path string, body io.Reader) (*http.Request, error)
  • func (c *Client) Patch(ctx context.Context, path string, out interface{}, opts ...RequestOption) error
  • func (c *Client) Post(ctx context.Context, path string, out interface{}, opts ...RequestOption) error
  • func (c *Client) Put(ctx context.Context, path string, out interface{}, opts ...RequestOption) error
• type ClientAuthenticator
• type ErrNotFound
  • func (e ErrNotFound) Error() string
• type ErrResponse
• type ErrUnexpectedStatus
  • func (e ErrUnexpectedStatus) Error() string
• type NoopAuthenticator
  • func (NoopAuthenticator) OnConnect(*http.Client) error
  • func (NoopAuthenticator) OnRequest(*http.Request) error
• type RequestOption
  • func WithJSONRequestBody(in interface{}) RequestOption
  • func WithQueryValue(key, value string) RequestOption
• type TLSClientCertificateAuthenticator
  • func (a *TLSClientCertificateAuthenticator) OnConnect(c *http.Client) error
  • func (a *TLSClientCertificateAuthenticator) OnRequest(r *http.Request) error

Functions

func IsNotFound

func IsNotFound(err error) bool

Types

type APIKeyAuthenticator

type APIKeyAuthenticator struct {
	APIKey string
}

func (*APIKeyAuthenticator) OnConnect

func (a *APIKeyAuthenticator) OnConnect(*http.Client) error

func (*APIKeyAuthenticator) OnRequest

func (a *APIKeyAuthenticator) OnRequest(r *http.Request) error

type BasicAuthenticator

type BasicAuthenticator struct {
	Username string
	Password string
}

func (*BasicAuthenticator) OnConnect

func (a *BasicAuthenticator) OnConnect(*http.Client) error

func (*BasicAuthenticator) OnRequest

func (a *BasicAuthenticator) OnRequest(r *http.Request) error

type Client

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

func NewClient

func NewClient(baseURL string, hc *http.Client, auth ClientAuthenticator, debugOutput io.Writer) *Client

NewClient returns a new PowerDNS HTTP client

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, path string, out interface{}, opts ...RequestOption) error

Delete executes a DELETE request

func (*Client) Do

func (c *Client) Do(ctx context.Context, req *http.Request, out interface{}) error

func (*Client) Get

func (c *Client) Get(ctx context.Context, path string, out interface{}, opts ...RequestOption) error

Get executes a GET request

func (*Client) NewRequest

func (c *Client) NewRequest(method string, path string, body io.Reader) (*http.Request, error)

NewRequest builds a new request. Usually, this method should not be used; prefer using the "Get", "Post", ... methods if possible.

func (*Client) Patch

func (c *Client) Patch(ctx context.Context, path string, out interface{}, opts ...RequestOption) error

Patch executes a PATCH request

func (*Client) Post

func (c *Client) Post(ctx context.Context, path string, out interface{}, opts ...RequestOption) error

Post executes a POST request

func (*Client) Put

func (c *Client) Put(ctx context.Context, path string, out interface{}, opts ...RequestOption) error

Put executes a PUT request

type ClientAuthenticator

type ClientAuthenticator interface {
	OnRequest(*http.Request) error
	OnConnect(*http.Client) error
}

type ErrNotFound

type ErrNotFound struct {
	URL string
}

func (ErrNotFound) Error

func (e ErrNotFound) Error() string

type ErrResponse

type ErrResponse struct {
	Message  string   `json:"error"`
	Messages []string `json:"errors,omitempty"`
}

ErrResponse represents error response from PowerDNS HTTP API

type ErrUnexpectedStatus

type ErrUnexpectedStatus struct {
	URL        string
	StatusCode int
	ErrResponse
}

func (ErrUnexpectedStatus) Error

func (e ErrUnexpectedStatus) Error() string

type NoopAuthenticator

type NoopAuthenticator struct{}

NoopAuthenticator provides an "empty" implementation of the ClientAuthenticator interface.

func (NoopAuthenticator) OnConnect

func (NoopAuthenticator) OnConnect(*http.Client) error

OnConnect is applied on the entire connection as soon as it is set up.

func (NoopAuthenticator) OnRequest

func (NoopAuthenticator) OnRequest(*http.Request) error

OnRequest is applied each time a HTTP request is built.

type RequestOption

type RequestOption func(*http.Request) error

RequestOption is a special type of function that can be passed to most HTTP request functions in this package; it is used to modify an HTTP request and to implement special request logic.

func WithJSONRequestBody

func WithJSONRequestBody(in interface{}) RequestOption

WithJSONRequestBody adds a JSON body to a request. The input type can be anything, as long as it can be marshaled by "json.Marshal". This method will also automatically set the correct content type and content-length.

func WithQueryValue

func WithQueryValue(key, value string) RequestOption

WithQueryValue adds a query parameter to a request's URL.

type TLSClientCertificateAuthenticator

type TLSClientCertificateAuthenticator struct {
	CACerts    []*x509.Certificate
	ClientCert tls.Certificate
	ClientKey  crypto.PrivateKey
}

func (*TLSClientCertificateAuthenticator) OnConnect

func (a *TLSClientCertificateAuthenticator) OnConnect(c *http.Client) error

func (*TLSClientCertificateAuthenticator) OnRequest

func (a *TLSClientCertificateAuthenticator) OnRequest(r *http.Request) error