delete

Documentation

Overview

Deletes an async EQL 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 New(tp elastictransport.Interface) *Delete
  • func (r Delete) Do(ctx 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(ctx context.Context) (bool, error)
  • func (r Delete) Perform(ctx context.Context) (*http.Response, error)
• type NewDelete
  • func NewDeleteFunc(tp elastictransport.Interface) NewDelete
• 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 Delete

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

func New

func New(tp elastictransport.Interface) *Delete

Deletes an async EQL 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/eql-search-api.html

func (Delete) Do

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

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

func (*Delete) Header

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

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

func (*Delete) HttpRequest

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

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

func (Delete) IsSuccess

func (r Delete) 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 (Delete) Perform

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

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

type NewDelete

type NewDelete func(id string) *Delete

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.

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response