http

Documentation

Index

• Variables
• func RetryPolicy(ctx context.Context, resp *http.Response, err error) (bool, error)
• type ClassicV2Authorizer
  • func (a *ClassicV2Authorizer) AuthorizeRequest(r *Request, c *config.Config)
• type Client
  • func NewClient(cfg config.Config) Client
  • func NewTestAPIClient(t *testing.T, handler http.Handler) Client
  • func (c *Client) Delete(url string, queryParams interface{}, respBody interface{}) (*http.Response, error)
  • func (c *Client) Do(req *Request) (*http.Response, error)
  • func (c *Client) Get(url string, queryParams interface{}, respBody interface{}) (*http.Response, error)
  • func (c *Client) NerdGraphQuery(query string, vars map[string]interface{}, respBody interface{}) error
  • func (c *Client) NewNerdGraphRequest(query string, vars map[string]interface{}, respBody interface{}) (*Request, error)
  • func (c *Client) NewRequest(method string, url string, params interface{}, reqBody interface{}, ...) (*Request, error)
  • func (c *Client) Post(url string, queryParams interface{}, reqBody interface{}, respBody interface{}) (*http.Response, error)
  • func (c *Client) Put(url string, queryParams interface{}, reqBody interface{}, respBody interface{}) (*http.Response, error)
  • func (c *Client) RawPost(url string, queryParams interface{}, reqBody interface{}, respBody interface{}) (*http.Response, error)
  • func (c *Client) SetAuthStrategy(da RequestAuthorizer)
  • func (c *Client) SetErrorValue(v ErrorResponse) *Client
• type DefaultErrorResponse
  • func (e *DefaultErrorResponse) Error() string
  • func (e *DefaultErrorResponse) New() ErrorResponse
• type ErrorDetail
• type ErrorResponse
• type LinkHeaderPager
  • func (l *LinkHeaderPager) Parse(resp *http.Response) Paging
• type NerdGraphAuthorizer
  • func (a *NerdGraphAuthorizer) AuthorizeRequest(r *Request, c *config.Config)
• type Pager
• type Paging
• type PersonalAPIKeyCapableV2Authorizer
  • func (a *PersonalAPIKeyCapableV2Authorizer) AuthorizeRequest(r *Request, c *config.Config)
• type Request
  • func (r *Request) SetAuthStrategy(ra RequestAuthorizer)
  • func (r *Request) SetErrorValue(e ErrorResponse)
  • func (r *Request) SetHeader(key string, value string)
  • func (r *Request) SetServiceName(serviceName string)
• type RequestAuthorizer

Variables

var (
	// ErrNotFound is returned when the resource was not found in New Relic.
	ErrNotFound = errors.New("newrelic: Resource not found")
)

Functions

func RetryPolicy

func RetryPolicy(ctx context.Context, resp *http.Response, err error) (bool, error)

RetryPolicy provides a callback for retryablehttp's CheckRetry, which will retry on connection errors and server errors.

Types

type ClassicV2Authorizer

type ClassicV2Authorizer struct{}

ClassicV2Authorizer authorizes V2 endpoints that cannot use a personal API key.

func (*ClassicV2Authorizer) AuthorizeRequest

func (a *ClassicV2Authorizer) AuthorizeRequest(r *Request, c *config.Config)

AuthorizeRequest is responsible for setting up auth for a request.

type Client

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

Client represents a client for communicating with the New Relic APIs.

func NewClient

func NewClient(cfg config.Config) Client

NewClient is used to create a new instance of Client.

func NewTestAPIClient

func NewTestAPIClient(t *testing.T, handler http.Handler) Client

NewTestAPIClient returns a test Client instance that is configured to communicate with a mock server.

func (*Client) Delete

func (c *Client) Delete(url string,
	queryParams interface{},
	respBody interface{},
) (*http.Response, error)

Delete represents an HTTP DELETE request to a New Relic API. The queryParams argument can be used to add query string parameters to the requested URL. The respBody argument will be unmarshaled from JSON in the response body to the type provided. If respBody is not nil and the response body cannot be unmarshaled to the type provided, an error will be returned.

func (*Client) Do

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

Do initiates an HTTP request as configured by the passed Request struct.

func (*Client) Get

func (c *Client) Get(
	url string,
	queryParams interface{},
	respBody interface{},
) (*http.Response, error)

Get represents an HTTP GET request to a New Relic API. The queryParams argument can be used to add query string parameters to the requested URL. The respBody argument will be unmarshaled from JSON in the response body to the type provided. If respBody is not nil and the response body cannot be unmarshaled to the type provided, an error will be returned.

func (*Client) NerdGraphQuery

func (c *Client) NerdGraphQuery(query string, vars map[string]interface{}, respBody interface{}) error

NerdGraphQuery runs a Nerdgraph query.

func (*Client) NewNerdGraphRequest

func (c *Client) NewNerdGraphRequest(query string, vars map[string]interface{}, respBody interface{}) (*Request, error)

NewNerdGraphRequest runs a Nerdgraph request object.

func (*Client) NewRequest

func (c *Client) NewRequest(method string, url string, params interface{}, reqBody interface{}, value interface{}) (*Request, error)

NewRequest creates a new Request struct.

func (*Client) Post

func (c *Client) Post(
	url string,
	queryParams interface{},
	reqBody interface{},
	respBody interface{},
) (*http.Response, error)

Post represents an HTTP POST request to a New Relic API. The queryParams argument can be used to add query string parameters to the requested URL. The reqBody argument will be marshaled to JSON from the type provided and included in the request body. The respBody argument will be unmarshaled from JSON in the response body to the type provided. If respBody is not nil and the response body cannot be unmarshaled to the type provided, an error will be returned.

func (*Client) Put

func (c *Client) Put(
	url string,
	queryParams interface{},
	reqBody interface{},
	respBody interface{},
) (*http.Response, error)

Put represents an HTTP PUT request to a New Relic API. The queryParams argument can be used to add query string parameters to the requested URL. The reqBody argument will be marshaled to JSON from the type provided and included in the request body. The respBody argument will be unmarshaled from JSON in the response body to the type provided. If respBody is not nil and the response body cannot be unmarshaled to the type provided, an error will be returned.

func (*Client) RawPost

func (c *Client) RawPost(
	url string,
	queryParams interface{},
	reqBody interface{},
	respBody interface{},
) (*http.Response, error)

RawPost behaves the same as Post, but without marshaling the body into JSON before making the request. This is required at least in the case of Synthetics Labels, since the POST doesn't handle JSON.

func (*Client) SetAuthStrategy

func (c *Client) SetAuthStrategy(da RequestAuthorizer)

SetAuthStrategy is used to set the default auth strategy for this client which can be overridden per request

func (*Client) SetErrorValue

func (c *Client) SetErrorValue(v ErrorResponse) *Client

SetErrorValue is used to unmarshal error body responses in JSON format.

type DefaultErrorResponse

type DefaultErrorResponse struct {
	ErrorDetail ErrorDetail `json:"error"`
}

DefaultErrorResponse represents the default error response from New Relic.

func (*DefaultErrorResponse) Error

func (e *DefaultErrorResponse) Error() string

func (*DefaultErrorResponse) New

func (e *DefaultErrorResponse) New() ErrorResponse

New creates a new instance of the DefaultErrorResponse struct.

type ErrorDetail

type ErrorDetail struct {
	Title    string   `json:"title"`
	Messages []string `json:"messages"`
}

ErrorDetail represents a New Relic response error detail.

type ErrorResponse

type ErrorResponse interface {
	Error() string
	New() ErrorResponse
}

ErrorResponse provides an interface for obtaining a single error message from an error response object.

type LinkHeaderPager

type LinkHeaderPager struct{}

LinkHeaderPager represents a pagination implementation that adheres to RFC 5988.

func (*LinkHeaderPager) Parse

func (l *LinkHeaderPager) Parse(resp *http.Response) Paging

Parse is used to parse a pagination context from an HTTP response.

type NerdGraphAuthorizer

type NerdGraphAuthorizer struct{}

NerdGraphAuthorizer authorizes calls to NerdGraph.

func (*NerdGraphAuthorizer) AuthorizeRequest

func (a *NerdGraphAuthorizer) AuthorizeRequest(r *Request, c *config.Config)

AuthorizeRequest is responsible for setting up auth for a request.

type Pager

type Pager interface {
	Parse(res *http.Response) Paging
}

Pager represents a pagination implementation.

type Paging

type Paging struct {
	Next string
}

Paging represents the pagination context returned from the Pager implementation.

type PersonalAPIKeyCapableV2Authorizer

type PersonalAPIKeyCapableV2Authorizer struct{}

PersonalAPIKeyCapableV2Authorizer authorizes V2 endpoints that can use a personal API key.

func (*PersonalAPIKeyCapableV2Authorizer) AuthorizeRequest

func (a *PersonalAPIKeyCapableV2Authorizer) AuthorizeRequest(r *Request, c *config.Config)

AuthorizeRequest is responsible for setting up auth for a request.

type Request

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

Request represents a configurable HTTP request.

func (*Request) SetAuthStrategy

func (r *Request) SetAuthStrategy(ra RequestAuthorizer)

SetAuthStrategy sets the authentication strategy for the request.

func (*Request) SetErrorValue

func (r *Request) SetErrorValue(e ErrorResponse)

SetErrorValue sets the error object for the request.

func (*Request) SetHeader

func (r *Request) SetHeader(key string, value string)

SetHeader sets a header on the underlying request.

func (*Request) SetServiceName

func (r *Request) SetServiceName(serviceName string)

SetServiceName sets the service name for the request.

type RequestAuthorizer

type RequestAuthorizer interface {
	AuthorizeRequest(r *Request, c *config.Config)
}

RequestAuthorizer is an interface that allows customizatino of how a request is authorized.