Documentation
¶
Overview ¶
Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.
Index ¶
- Variables
- type Delete
- func (r Delete) Do(providedCtx context.Context) (*Response, error)
- func (r *Delete) Header(key, value string) *Delete
- func (r *Delete) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r Delete) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Delete) Perform(providedCtx context.Context) (*http.Response, error)
- type NewDelete
- 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 Delete ¶
type Delete struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Delete
Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.
https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
func (Delete) Do ¶
Do runs the request through the transport, handle the response and returns a delete.Response
func (*Delete) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
type NewDelete ¶
NewDelete type alias for index.
func NewDeleteFunc ¶
func NewDeleteFunc(tp elastictransport.Interface) NewDelete
NewDeleteFunc returns a new instance of Delete with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files