help

package

v9.0.0 Latest Latest Go to latest Published: Apr 17, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/elastic/go-elasticsearch

Links

Open Source Insights

Documentation ¶

Overview ¶

Get CAT help.

Get help for the CAT APIs.

Index ¶

Constants ¶

This section is empty.

Variables ¶

View Source

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.

Functions ¶

This section is empty.

Types ¶

type Help ¶

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

func New ¶

func New(tp elastictransport.Interface) *Help

Get CAT help.

Get help for the CAT APIs.

https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cat

func (Help) Do ¶

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

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

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(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 (Help) Perform ¶

func (r Help) Perform(providedCtx 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.