Documentation ¶
Overview ¶
Returns help for the Cat APIs.
Index ¶
- Variables
- type Help
- func (r Help) Do(providedCtx 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(providedCtx context.Context) (bool, error)
- func (r Help) Perform(providedCtx context.Context) (*http.Response, error)
- type NewHelp
- type Response
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
Returns help for the Cat APIs.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html
func (Help) Do ¶
Do runs the request through the transport, handle the response and returns a help.Response
func (*Help) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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 ¶ added in v8.7.0
type Response []types.HelpRecord
Click to show internal directories.
Click to hide internal directories.