Documentation ¶
Overview ¶
Returns the existing search applications.
Index ¶
- Variables
- type List
- func (r List) Do(providedCtx context.Context) (*Response, error)
- func (r *List) From(from int) *List
- func (r *List) Header(key, value string) *List
- func (r *List) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r List) IsSuccess(providedCtx context.Context) (bool, error)
- func (r List) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *List) Q(q string) *List
- func (r *List) Size(size int) *List
- type NewList
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type List ¶
type List struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *List
Returns the existing search applications.
https://www.elastic.co/guide/en/elasticsearch/reference/current/list-search-applications.html
func (List) Do ¶
Do runs the request through the transport, handle the response and returns a list.Response
func (*List) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (List) IsSuccess ¶
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 (List) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
type NewList ¶
type NewList func() *List
NewList type alias for index.
func NewListFunc ¶
func NewListFunc(tp elastictransport.Interface) NewList
NewListFunc returns a new instance of List with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶
type Response struct { Count int64 `json:"count"` Results []types.SearchApplicationListItem `json:"results"` }
Response holds the response body struct for the package list