base

Documentation

Index

• func GetAuthenticatorFromEnvironment(credentialKey string) (core.Authenticator, error)
• func NewErrorResponse(rt http.RoundTripper) http.RoundTripper
• type BaseService
  • func NewBaseService(opts *core.ServiceOptions) (*BaseService, error)
  • func (c *BaseService) Clone() *BaseService
  • func (c *BaseService) Request(req *http.Request, result interface{}) (detailedResponse *core.DetailedResponse, err error)
  • func (c *BaseService) SetHTTPClient(client *http.Client)
  • func (c *BaseService) SetServiceURL(url string) error
• type ErrorResponse
  • func (er *ErrorResponse) RoundTrip(req *http.Request) (resp *http.Response, err error)

Functions

func GetAuthenticatorFromEnvironment

func GetAuthenticatorFromEnvironment(credentialKey string) (core.Authenticator, error)

GetAuthenticatorFromEnvironment instantiates an Authenticator using service properties retrieved from external config sources.

func NewErrorResponse

func NewErrorResponse(rt http.RoundTripper) http.RoundTripper

NewErrorResponse creates a new ErrorResponse middleware

Types

type BaseService

type BaseService struct {
	*core.BaseService
	// contains filtered or unexported fields
}

func NewBaseService

func NewBaseService(opts *core.ServiceOptions) (*BaseService, error)

func (*BaseService) Clone

func (c *BaseService) Clone() *BaseService

func (*BaseService) Request

func (c *BaseService) Request(req *http.Request, result interface{}) (detailedResponse *core.DetailedResponse, err error)

func (*BaseService) SetHTTPClient

func (c *BaseService) SetHTTPClient(client *http.Client)

SetHTTPClient will set "client" as the http.Client instance to be used to invoke individual HTTP requests. If automatic retries are currently enabled on "service", then "client" will be set as the embedded client instance within the retryable client; otherwise "client" will be stored directly on "service".

func (*BaseService) SetServiceURL

func (c *BaseService) SetServiceURL(url string) error

type ErrorResponse

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

ErrorResponse is an error augmentation RoundTripper that in case of http error response parses the return body and converts it to a closer match to the standard error including adding a trace ID and appending the CouchDB/Cloudant error reason to the message

func (*ErrorResponse) RoundTrip

func (er *ErrorResponse) RoundTrip(req *http.Request) (resp *http.Response, err error)

RoundTrip implements RoundTripper interface