asyncquery

Documentation

Overview

Executes an ESQL request asynchronously

Index

• Variables
• type AsyncQuery
  • func New(tp elastictransport.Interface) *AsyncQuery
  • func (r AsyncQuery) Do(ctx context.Context) (bool, error)
  • func (r *AsyncQuery) Header(key, value string) *AsyncQuery
  • func (r *AsyncQuery) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r AsyncQuery) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r AsyncQuery) Perform(providedCtx context.Context) (*http.Response, error)
• type NewAsyncQuery
  • func NewAsyncQueryFunc(tp elastictransport.Interface) NewAsyncQuery

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 AsyncQuery

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

func New

func New(tp elastictransport.Interface) *AsyncQuery

Executes an ESQL request asynchronously

https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-api.html

func (AsyncQuery) Do

func (r AsyncQuery) Do(ctx context.Context) (bool, error)

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

func (*AsyncQuery) Header

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

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

func (*AsyncQuery) HttpRequest

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

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

func (AsyncQuery) IsSuccess

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

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

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

type NewAsyncQuery

type NewAsyncQuery func() *AsyncQuery

NewAsyncQuery type alias for index.

func NewAsyncQueryFunc

func NewAsyncQueryFunc(tp elastictransport.Interface) NewAsyncQuery

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