services

type AuthnResponseHandler struct {
	TokenRetriever idp.TokenRetriever
}

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

type Config struct {
	// TokenRetriever to gather access tokens to be sent in the Authorization: Bearer header on client initialization and upon encountering a 401 response
	TokenRetriever idp.TokenRetriever
	// Token to be sent in the Authorization: Bearer header (not required if TokenRetriever is specified)
	Token string
	// Tenant is the default Tenant used to form requests
	Tenant string
	// Host is the (optional) default host or host:port used to form requests, `"scp.splunk.com"` by default.
	// NOTE: This is really a root domain, most requests will be formed using `<config.Scheme>://api.<config.Host>/<tenant>/<service>/<version>/...` where `api` could vary by service
	Host string
	// OverrideHost if set would override the Splunk Cloud root domain (`"scp.splunk.com"` by default) and service settings when forming the host such that requests would be made to `"<scheme>://<overrideHost>/..."` for all services.
	// NOTE: Providing a Host and OverrideHost is not valid.
	OverrideHost string
	// Scheme is the (optional) default HTTP Scheme used to form requests, `"https"` by default
	Scheme string
	// Timeout is the (optional) default request-level timeout to use, 5 seconds by default
	Timeout time.Duration
	// ResponseHandlers is an (optional) slice of handlers to call after a response has been
	// received in the client - handlers can optionally implement the ResponseOrErrorHandler
	// interface as well for handling request errors as well as responses
	ResponseHandlers []ResponseHandler
	// RetryRequests Knob that will turn on and off retrying incoming service requests when they result in the service returning a 429 TooManyRequests Error or a connection reset error
	RetryRequests bool
	// RetryStrategyConfig
	RetryConfig RetryStrategyConfig
	// RoundTripper
	RoundTripper http.RoundTripper
	// TokenExpireWindow is the (optional) window within which a new token gets retreieved before the existing token expires. Default to 1 minute
	TokenExpireWindow time.Duration
	// ClientVersion contains the client name and its current version in string format
	ClientVersion string
	// TenantScoped is bool True if the hostnames are scoped to a specific tenant/region
	TenantScoped bool
	// Region is the name of the region that the tenant is contained in
	Region string
}

type ConfigurableRetryConfig struct {
	// RetryNum defines the number of attempts to retry, if attempts > RetryNum then no more retries are attempted
	RetryNum uint
	// Interval defines the interval in milliseconds for exponential backoff where backoff = interval * 2^(retry num)
	Interval int
	// ShouldRetryFn defines a custom function to determine whether or not to retry the request
	ShouldRetryFn ShouldRetry
}

type ConfigurableRetryResponseHandler struct {
	ConfigurableRetryConfig ConfigurableRetryConfig
}

type DefaultRetryConfig struct {
}

type DefaultRetryResponseHandler struct {
	DefaultRetryConfig DefaultRetryConfig
}

type Request struct {
	*http.Request
	NumAttempts     uint
	NumErrorsByType map[string]uint
}

type ResponseHandler interface {
	HandleResponse(client *BaseClient, request *Request, response *http.Response) (*http.Response, error)
}

type ResponseOrErrorHandler interface {
	HandleRequestError(client *BaseClient, request *Request, err error) (*http.Response, error)
	HandleResponse(client *BaseClient, request *Request, response *http.Response) (*http.Response, error)
}

type RetryStrategyConfig struct {
	DefaultRetryConfig      *DefaultRetryConfig
	ConfigurableRetryConfig *ConfigurableRetryConfig
}

type ShouldRetry func(request *Request, reqErr error, response *http.Response, maxRetries uint) bool