Documentation ¶
Overview ¶
Returns async results from previously executed Event Query Language (EQL) search
Index ¶
- Variables
- type Get
- func (r Get) Do(ctx context.Context) (*Response, error)
- func (r *Get) Header(key, value string) *Get
- func (r *Get) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r Get) IsSuccess(ctx context.Context) (bool, error)
- func (r *Get) KeepAlive(duration string) *Get
- func (r Get) Perform(ctx context.Context) (*http.Response, error)
- func (r *Get) WaitForCompletionTimeout(duration string) *Get
- type NewGet
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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 ¶
Do runs the request through the transport, handle the response and returns a get.Response
func (*Get) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (Get) IsSuccess ¶
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 ¶
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 ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Get) WaitForCompletionTimeout ¶
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 ¶
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 ¶ added in v8.7.0
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