help

Documentation

Overview

Returns help for the Cat APIs.

Index

• Variables
• type Help
  • func New(tp elastictransport.Interface) *Help
  • func (r Help) Do(ctx context.Context) (Response, error)
  • func (r *Help) Header(key, value string) *Help
  • func (r *Help) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Help) IsSuccess(ctx context.Context) (bool, error)
  • func (r Help) Perform(ctx context.Context) (*http.Response, error)
• type NewHelp
  • func NewHelpFunc(tp elastictransport.Interface) NewHelp
• type Response
  • func NewResponse() Response

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 Help

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

func New

func New(tp elastictransport.Interface) *Help

Returns help for the Cat APIs.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat.html

func (Help) Do

func (r Help) Do(ctx context.Context) (Response, error)

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

func (*Help) Header

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

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

func (*Help) HttpRequest

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

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

func (Help) IsSuccess

func (r Help) IsSuccess(ctx 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 (Help) Perform

func (r Help) Perform(ctx context.Context) (*http.Response, error)

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

type NewHelp

type NewHelp func() *Help

NewHelp type alias for index.

func NewHelpFunc

func NewHelpFunc(tp elastictransport.Interface) NewHelp

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

type Response

type Response []types.HelpRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response