Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v1

v1.2.30

Feb 19, 2024

v1.2.19

Feb 19, 2024

v1.2.9

Feb 19, 2024

v1.2.8

Feb 19, 2024

v1.2.7

Feb 19, 2024

v1.2.4

Feb 19, 2024

Changes in this version

+ const ESSEndpoint

+ const RegionBasePath

+ const Version

+ var DefaultBasePath = client.DefaultBasePath

+ var DefaultMockHost = "mock.elastic.co"

+ var DefaultReadMockHeaders = map[string][]string

+ var DefaultTimeout = 30 * time.Second

+ var DefaultTransport = new(ErrCatchTransport)

+ var DefaultUserAgent = "cloud-sdk-go/" + Version

+ var DefaultWriteMockHeaders = map[string][]string

+ func AddTypeConsumers(rtime *client.Runtime) *client.Runtime

+ func GetContextRegion(ctx context.Context) (string, bool)

+ func LoginUser(instance *API, writer io.Writer) error

+ func NewTransport(rt http.RoundTripper, cfg TransportConfig) (http.RoundTripper, error)

+ func ReturnErrOnly(_ interface{}, err error) error

+ func UnwrapError(err error) error

+ func WithRegion(ctx context.Context, region string) context.Context

+ type API struct

+ AuthWriter auth.Writer

+ V1API *client.Rest

+ func NewAPI(c Config) (*API, error)

+ func NewDebugMock(o io.Writer, res ...mock.Response) *API

+ func NewMock(res ...mock.Response) *API

+ type AuthWriter auth.Writer

+ type CloudClientRuntime struct

+ func NewCloudClientRuntime(c Config) (*CloudClientRuntime, error)

+ func (r *CloudClientRuntime) Submit(op *runtime.ClientOperation) (interface{}, error)

+ type Config struct

+ AuthWriter auth.Writer

+ Client *http.Client

+ ErrorDevice io.Writer

+ Host string

+ Retries int

+ RetryBackoff time.Duration

+ SkipLogin bool

+ SkipTLSVerify bool

+ Timeout time.Duration

+ UserAgent string

+ func (c *Config) Validate() error

+ type CustomTransport struct

+ func NewCustomTransport(cfg CustomTransportCfg) (*CustomTransport, error)

+ func (t *CustomTransport) RoundTrip(req *http.Request) (*http.Response, error)

+ type CustomTransportCfg struct

+ Backoff time.Duration

+ RedactAuth bool

+ Retries int

+ RoundTripper http.RoundTripper

+ UserAgent string

+ Verbose bool

+ Writer io.Writer

+ type DebugTransport struct

+ func NewDebugTransport(transport http.RoundTripper, o io.Writer, obscure bool) *DebugTransport

+ func (t *DebugTransport) RoundTrip(req *http.Request) (res *http.Response, err error)

+ type ErrCatchTransport struct

+ func NewErrCatchTransport(rt http.RoundTripper) *ErrCatchTransport

+ func (e *ErrCatchTransport) RoundTrip(req *http.Request) (*http.Response, error)

+ type TransportConfig struct

+ ErrorDevice io.Writer

+ Retries int

+ RetryBackoff time.Duration

+ SkipTLSVerify bool

+ Timeout time.Duration

+ UserAgent string

+ type UserAgentTransport struct

+ func NewUserAgentTransport(rt http.RoundTripper, agent string) *UserAgentTransport

+ func (ua *UserAgentTransport) RoundTrip(req *http.Request) (*http.Response, error)

+ type VerboseSettings struct

+ Device io.Writer

+ RedactAuth bool

+ Verbose bool

+ func (settings VerboseSettings) Validate() error