getstatus

Documentation

Overview

Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetStatus

Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.

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

func (GetStatus) Do

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

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

func (*GetStatus) ErrorTrace

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

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

func (*GetStatus) FilterPath

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

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

func (*GetStatus) Header

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

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

func (*GetStatus) HttpRequest

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

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

func (*GetStatus) Human

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

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

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

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

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

func (*GetStatus) Pretty

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

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

type NewGetStatus

type NewGetStatus func(id string) *GetStatus

NewGetStatus type alias for index.

func NewGetStatusFunc

func NewGetStatusFunc(tp elastictransport.Interface) NewGetStatus

NewGetStatusFunc returns a new instance of GetStatus 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 {

	// CompletionStatus For a completed search shows the http status code of the completed search.
	CompletionStatus *int `json:"completion_status,omitempty"`
	// ExpirationTimeInMillis Shows a timestamp when the eql search will be expired, in milliseconds since
	// the Unix epoch. When this time is reached, the search and its results are
	// deleted, even if the search is still ongoing.
	ExpirationTimeInMillis *int64 `json:"expiration_time_in_millis,omitempty"`
	// Id Identifier for the search.
	Id string `json:"id"`
	// IsPartial If true, the search request is still executing. If false, the search is
	// completed.
	IsPartial bool `json:"is_partial"`
	// IsRunning If true, the response does not contain complete search results. This could be
	// because either the search is still running (is_running status is false), or
	// because it is already completed (is_running status is true) and results are
	// partial due to failures or timeouts.
	IsRunning bool `json:"is_running"`
	// StartTimeInMillis For a running search shows a timestamp when the eql search started, in
	// milliseconds since the Unix epoch.
	StartTimeInMillis *int64 `json:"start_time_in_millis,omitempty"`
}

Response holds the response body struct for the package getstatus

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/eql/get_status/EqlGetStatusResponse.ts#L24-L51

func NewResponse

func NewResponse() *Response

NewResponse returns a Response