Documentation
¶
Overview ¶
Returns the status of a previously submitted async or stored Event Query Language (EQL) search
Index ¶
- Variables
- type GetStatus
- func (r GetStatus) Do(ctx context.Context) (*Response, error)
- func (r *GetStatus) Header(key, value string) *GetStatus
- func (r *GetStatus) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetStatus) Id(v string) *GetStatus
- func (r GetStatus) IsSuccess(ctx context.Context) (bool, error)
- func (r GetStatus) Perform(ctx context.Context) (*http.Response, error)
- type NewGetStatus
- 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 GetStatus ¶
type GetStatus struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetStatus
Returns the status of a previously submitted async or stored Event Query Language (EQL) search
https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html
func (GetStatus) Do ¶
Do runs the request through the transport, handle the response and returns a getstatus.Response
func (*GetStatus) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
type NewGetStatus ¶
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"`
}
Source Files