capabilities

Documentation

Overview

Checks if the specified combination of method, API, parameters, and arbitrary capabilities are supported

Index

• Variables
• type Capabilities
  • func New(tp elastictransport.Interface) *Capabilities
  • func (r Capabilities) Do(ctx context.Context) (bool, error)
  • func (r *Capabilities) Header(key, value string) *Capabilities
  • func (r *Capabilities) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Capabilities) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Capabilities) Perform(providedCtx context.Context) (*http.Response, error)
• type NewCapabilities
  • func NewCapabilitiesFunc(tp elastictransport.Interface) NewCapabilities

Variables

var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")

ErrBuildPath is returned in case of missing parameters within the build of the request.

Types

type Capabilities

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

func New

func New(tp elastictransport.Interface) *Capabilities

Checks if the specified combination of method, API, parameters, and arbitrary capabilities are supported

https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/README.asciidoc#require-or-skip-api-capabilities

func (Capabilities) Do

func (r Capabilities) Do(ctx context.Context) (bool, error)

Do runs the request through the transport, handle the response and returns a capabilities.Response

func (*Capabilities) Header

func (r *Capabilities) Header(key, value string) *Capabilities

Header set a key, value pair in the Capabilities headers map.

func (*Capabilities) HttpRequest

func (r *Capabilities) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (Capabilities) IsSuccess

func (r Capabilities) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (Capabilities) Perform

func (r Capabilities) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

type NewCapabilities

type NewCapabilities func() *Capabilities

NewCapabilities type alias for index.

func NewCapabilitiesFunc

func NewCapabilitiesFunc(tp elastictransport.Interface) NewCapabilities

NewCapabilitiesFunc returns a new instance of Capabilities with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.