Package deploymentapi contains curated functions which iteract with the deployments API, exposing an API which its usage is preferred over the direct client calls.

Package mock provides functions and types to help test and stub external calls that the API structures would otherwise perform causing external calls through the network.

Package userapi contains the methods required to manage platform users.

AddTypeConsumers adds the missing consumers and producers to the client.Runtime.

GetContextRegion returns the region from a specified context, if any.

LoginUser logs in a user when its AuthWriter is of type *auth.UserLogin.

NewAPI initializes the API clients from an API config that it receives.

NewCloudClientRuntime creates a CloudClientRuntime from the config.

NewCustomTransport creates a new CustomTransport.

NewDebugMock creates a new api.API from a list of Responses.

NewDebugTransport Deprecated: factory for DebugTransport.

NewErrCatchTransport Deprecated: initializes an ErrCatchTransport.

NewMock creates a new api.API from a list of Responses.

NewMockMatchingByEndpoint creates a new api.API from a list of Responses, matching by endpoint.

NewTransport constructs a new http.RoundTripper from its config.

NewUserAgentTransport Deprecated: initializes a new UserAgentTransport.

ReturnErrOnly is used to strip the first return argument of a function call.

UnwrapError Deprecated: unpacks an error message returned from a client API call.

WithRegion creates a new context with a region value.

ESSEndpoint is the Elasticsearch Service endpoint.

RegionBasePath is for /platform operations which require a Region to be passed as of an API call context.Context.

Version contains the ECE API version compatibility for the current auto-generated client and models.

DefaultBasePath is used as the base prefix for the API.

DefaultMockHost can be used for test assertions.

DefaultReadMockHeaders can be used for test assertions.

DefaultTimeout is used when TransportConfig.Transport is not specified.

DefaultTransport can be used by clients which rely on the apierror.Unwrap Can obtain the underlying http.Response is returned with a StatusCode not defined within the swagger spec from which the models have been generated.

DefaultUserAgent is used in UserAgentTransport when the agent is not set.

DefaultWriteMockHeaders can be used for test assertions.

API contains all of the API clients and authentication objects necessary for the EC API.

CloudClientRuntime wraps runtimeclient.Runtime to allow operations to use a transport depending on the operation which is being performed.

Config contains the API config.

CustomTransport is the cloud-sdk-go custom transport which handles all the add-ons for http request and responses.

CustomTransportCfg is used to configure a CustomTransport.

DebugTransport Deprecated: is an http.RoundTripper that keeps track of the in-flight request and implements hooks to report HTTP tracing events.

ErrCatchTransport Deprecated: is an http.RoundTripper that which allows the http.Response to be accessed in certain types of wrapped errors returned by autogenerated code.

TransportConfig is meant to be used so an http.RoundTripper is constructed with the appropriate settings.

UserAgentTransport Deprecated: wraps an http.RoundTripper and adds an User -Agent header to all requests which are processed through the structure.

VerboseSettings define the behaviour of verbosity.

AuthWriter wraps the runtime.ClientAuthInfoWriter interface adding a method to Auth generic http.Request.