asyncquerystop

Documentation

Overview

Stop async ES|QL query.

This API interrupts the query execution and returns the results so far. If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.

Index

• Variables
• type AsyncQueryStop
  • func New(tp elastictransport.Interface) *AsyncQueryStop
  • func (r AsyncQueryStop) Do(providedCtx context.Context) (Response, error)
  • func (r *AsyncQueryStop) DropNullColumns(dropnullcolumns bool) *AsyncQueryStop
  • func (r *AsyncQueryStop) ErrorTrace(errortrace bool) *AsyncQueryStop
  • func (r *AsyncQueryStop) FilterPath(filterpaths ...string) *AsyncQueryStop
  • func (r *AsyncQueryStop) Header(key, value string) *AsyncQueryStop
  • func (r *AsyncQueryStop) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *AsyncQueryStop) Human(human bool) *AsyncQueryStop
  • func (r AsyncQueryStop) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r AsyncQueryStop) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *AsyncQueryStop) Pretty(pretty bool) *AsyncQueryStop
• type NewAsyncQueryStop
  • func NewAsyncQueryStopFunc(tp elastictransport.Interface) NewAsyncQueryStop
• 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 AsyncQueryStop

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

func New

func New(tp elastictransport.Interface) *AsyncQueryStop

Stop async ES|QL query.

This API interrupts the query execution and returns the results so far. If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-esql-async-query-stop

func (AsyncQueryStop) Do

func (r AsyncQueryStop) Do(providedCtx context.Context) (Response, error)

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

func (*AsyncQueryStop) DropNullColumns

func (r *AsyncQueryStop) DropNullColumns(dropnullcolumns bool) *AsyncQueryStop

DropNullColumns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. API name: drop_null_columns

func (*AsyncQueryStop) ErrorTrace

func (r *AsyncQueryStop) ErrorTrace(errortrace bool) *AsyncQueryStop

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*AsyncQueryStop) FilterPath

func (r *AsyncQueryStop) FilterPath(filterpaths ...string) *AsyncQueryStop

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*AsyncQueryStop) Header

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

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

func (*AsyncQueryStop) HttpRequest

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

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

func (*AsyncQueryStop) Human

func (r *AsyncQueryStop) Human(human bool) *AsyncQueryStop

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (AsyncQueryStop) IsSuccess

func (r AsyncQueryStop) IsSuccess(providedCtx 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 (AsyncQueryStop) Perform

func (r AsyncQueryStop) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*AsyncQueryStop) Pretty

func (r *AsyncQueryStop) Pretty(pretty bool) *AsyncQueryStop

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

type NewAsyncQueryStop

type NewAsyncQueryStop func(id string) *AsyncQueryStop

NewAsyncQueryStop type alias for index.

func NewAsyncQueryStopFunc

func NewAsyncQueryStopFunc(tp elastictransport.Interface) NewAsyncQueryStop

NewAsyncQueryStopFunc returns a new instance of AsyncQueryStop with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Response

type Response = []byte

func NewResponse

func NewResponse() Response

NewResponse returns a Response