# Functions
ChainMiddleware chains multiple middlewares to create a single http.RoundTripper The middlewares are applied in reverse order, so the last middleware provided in the arguments is the first to be executed If the root http.RoundTripper is nil, http.DefaultTransport is used.
ConfigureRegion configures the API server urls with the user specified region.
WithBackgroundTokenRefresh returns a ConfigurationOption that enables access token refreshing in backgound.
WithCaptureHTTPResponse adds the raw HTTP response retrieval annotation to the parent context.
WithCheckRedirect returns a ConfigurationOption that specifies the HTTP client checkRedirect function.
WithCustomAuth returns a ConfigurationOption that provides a custom http.Roundtripper for making authenticated requests.
WithCustomConfiguration returns a ConfigurationOption that sets a custom Configuration.
WithEndpoint returns a ConfigurationOption that overrides the default endpoint to be used for the client This option takes precedence over withRegion.
WithHTTPClient returns a ConfigurationOption that specifies the HTTP client to use as basis for the communication.
WithJar returns a ConfigurationOption that specifies the HTTP client cookie jar.
Deprecated: retry options were removed to reduce complexity of the client.
WithMiddleware returns a ConfigurationOption that adds a Middleware to the client.
WithRetryTimeout returns a ConfigurationOption that specifies the maximum time for ret WithoutAuthentication returns a ConfigurationOption that disables authentication.
WithPrivateKey returns a ConfigurationOption that sets the private key This option takes precedence over WithPrivateKeyPath.
WithPrivateKeyPath returns a ConfigurationOption that sets the private key path.
WithRegion returns a ConfigurationOption that specifies the region to be used.
Deprecated: retry options were removed to reduce complexity of the client.
WithServiceAccountEmail returns a ConfigurationOption that sets the service account email.
WithServiceAccountKey returns a ConfigurationOption that sets the service account key This option takes precedence over WithServiceAccountKeyPath.
WithServiceAccountKeyPath returns a ConfigurationOption that sets the service account key path.
WithTimeout returns a ConfigurationOption that specifies the HTTP client timeout.
WithToken returns a ConfigurationOption that sets a token to be used for authentication in API calls.
WithTokenEndpoint returns a ConfigurationOption that overrides the default url to be used to get a token when using the key flow.
WithUserAgent returns a ConfigurationOption that defines the User-Agent.
Deprecated: retry options were removed to reduce complexity of the client.
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHTTPRequest holds the raw HTTP request.
ContextHTTPResponse holds the raw HTTP response after the request has completed.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.
# Structs
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
# Type aliases
ConfigurationOption is an option for an API client.
Middleware is a function that wraps an http.RoundTripper to provide additional functionality such as logging, authentication, etc.
ServerConfigurations stores multiple ServerConfiguration items.