get

Documentation

Overview

Returns async results from previously executed Event Query Language (EQL) search

Index

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

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

func New

func New(tp elastictransport.Interface) *Get

Returns async results from previously executed Event Query Language (EQL) search

https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-eql-search-api.html

func (Get) Do

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

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

func (*Get) ErrorTrace

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

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

func (*Get) FilterPath

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

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

func (*Get) Header

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

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

func (*Get) HttpRequest

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

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

func (*Get) Human

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

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 (Get) IsSuccess

func (r Get) 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 (*Get) KeepAlive

func (r *Get) KeepAlive(duration string) *Get

KeepAlive Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request. API name: keep_alive

func (Get) Perform

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

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

func (*Get) Pretty

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

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

func (*Get) WaitForCompletionTimeout

func (r *Get) WaitForCompletionTimeout(duration string) *Get

WaitForCompletionTimeout Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results. API name: wait_for_completion_timeout

type NewGet

type NewGet func(id string) *Get

NewGet type alias for index.

func NewGetFunc

func NewGetFunc(tp elastictransport.Interface) NewGet

NewGetFunc returns a new instance of Get 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 {

	// Hits Contains matching events and sequences. Also contains related metadata.
	Hits types.EqlHits `json:"hits"`
	// Id Identifier for the search.
	Id *string `json:"id,omitempty"`
	// IsPartial If true, the response does not contain complete search results.
	IsPartial *bool `json:"is_partial,omitempty"`
	// IsRunning If true, the search request is still executing.
	IsRunning *bool `json:"is_running,omitempty"`
	// TimedOut If true, the request timed out before completion.
	TimedOut *bool `json:"timed_out,omitempty"`
	// Took Milliseconds it took Elasticsearch to execute the request.
	Took *int64 `json:"took,omitempty"`
}

Response holds the response body struct for the package get

https://github.com/elastic/elasticsearch-specification/blob/07bf82537a186562d8699685e3704ea338b268ef/specification/eql/get/EqlGetResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response