Documentation
¶
Index ¶
Constants ¶
const Version = "9.0.0"
Version of the client.
const VersionHeader = "X-Client-Version"
VersionHeader is sent with every request.
Variables ¶
This section is empty.
Functions ¶
func WithRetryPolicy ¶
func WithRetryPolicy(ctx context.Context, retryPolicy RetryPolicy) context.Context
WithRetryPolicy returns a new context that overrides the client object's retry policy.
Types ¶
type Client ¶
type Client interface {
// HealthCheck makes a GET request to /health/check
//
// 200: nil
// 400: *models.BadRequest
// 500: *models.InternalError
// default: client side HTTP errors, for example: context.DeadlineExceeded.
HealthCheck(ctx context.Context) error
}
Client defines the methods available to clients of the swagger-test service.
type ExponentialRetryPolicy ¶
type ExponentialRetryPolicy struct{}
ExponentialRetryPolicy defines an exponential retry policy
func (ExponentialRetryPolicy) Backoffs ¶
func (ExponentialRetryPolicy) Backoffs() []time.Duration
Backoffs returns five backoffs with exponentially increasing wait times between requests: 100, 200, 400, 800, and 1600 milliseconds +/- up to 5% jitter.
type NoRetryPolicy ¶
type NoRetryPolicy struct{}
NoRetryPolicy defines a policy of never retrying a request.
func (NoRetryPolicy) Backoffs ¶
func (NoRetryPolicy) Backoffs() []time.Duration
Backoffs returns an empty slice.
type RetryPolicy ¶
type RetryPolicy interface {
// Backoffs returns the number and timing of retry attempts.
Backoffs() []time.Duration
// Retry receives the http request, as well as the result of
// net/http.Client's `Do` method.
Retry(*http.Request, *http.Response, error) bool
}
RetryPolicy defines a retry policy.
type SingleRetryPolicy ¶
type SingleRetryPolicy struct{}
SingleRetryPolicy defines a retry that retries a request once
func (SingleRetryPolicy) Backoffs ¶
func (SingleRetryPolicy) Backoffs() []time.Duration
Backoffs returns that you should retry the request 1second after it fails.
type WagClient ¶
type WagClient struct {
// contains filtered or unexported fields
}
WagClient is used to make requests to the swagger-test service.
func New ¶
func New(basePath string, logger wcl.WagClientLogger, transport *http.RoundTripper) *WagClient
New creates a new client. The base path, logger, and http transport are configurable. The logger provided should be specifically created for this wag client. If tracing is required, provide an instrumented transport using the wag clientconfig module. If no tracing is required, pass nil to use the default transport.
func NewFromDiscovery ¶
func NewFromDiscovery(logger wcl.WagClientLogger, transport *http.RoundTripper) (*WagClient, error)
NewFromDiscovery creates a client from the discovery environment variables. This method requires the three env vars: SERVICE_SWAGGER_TEST_HTTP_(HOST/PORT/PROTO) to be set. Otherwise it returns an error. The logger provided should be specifically created for this wag client. If tracing is required, provide an instrumented transport using the wag clientconfig module. If no tracing is required, pass nil to use the default transport.
func (*WagClient) HealthCheck ¶
HealthCheck makes a GET request to /health/check
200: nil 400: *models.BadRequest 500: *models.InternalError default: client side HTTP errors, for example: context.DeadlineExceeded.
func (*WagClient) SetLogger ¶
func (c *WagClient) SetLogger(l wcl.WagClientLogger)
SetLogger allows for setting a custom logger
func (*WagClient) SetRetryPolicy ¶
func (c *WagClient) SetRetryPolicy(retryPolicy RetryPolicy)
SetRetryPolicy sets a the given retry policy for all requests.
func (*WagClient) SetTimeout ¶
SetTimeout sets a timeout on all operations for the client. To make a single request with a shorter timeout than the default on the client, use context.WithTimeout as described here: https://godoc.org/golang.org/x/net/context#WithTimeout.
Source Files