deleteasync

Documentation

Overview

Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.

Index

• Variables
• type DeleteAsync
  • func New(tp elastictransport.Interface) *DeleteAsync
  • func (r DeleteAsync) Do(ctx context.Context) (*Response, error)
  • func (r *DeleteAsync) Header(key, value string) *DeleteAsync
  • func (r *DeleteAsync) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *DeleteAsync) Id(v string) *DeleteAsync
  • func (r DeleteAsync) IsSuccess(ctx context.Context) (bool, error)
  • func (r DeleteAsync) Perform(ctx context.Context) (*http.Response, error)
• type NewDeleteAsync
  • func NewDeleteAsyncFunc(tp elastictransport.Interface) NewDeleteAsync
• 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 DeleteAsync

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

func New

func New(tp elastictransport.Interface) *DeleteAsync

Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.

https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html

func (DeleteAsync) Do

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

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

func (*DeleteAsync) Header

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

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

func (*DeleteAsync) HttpRequest

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

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

func (*DeleteAsync) Id

func (r *DeleteAsync) Id(v string) *DeleteAsync

Id The async search ID API Name: id

func (DeleteAsync) IsSuccess

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

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

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

type NewDeleteAsync

type NewDeleteAsync func(id string) *DeleteAsync

NewDeleteAsync type alias for index.

func NewDeleteAsyncFunc

func NewDeleteAsyncFunc(tp elastictransport.Interface) NewDeleteAsync

NewDeleteAsyncFunc returns a new instance of DeleteAsync 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