getstatus

package
v8.13.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2024 License: Apache-2.0 Imports: 11 Imported by: 3

Documentation

Overview

Returns the status of a previously submitted async or stored Event Query Language (EQL) search

Index

Constants

This section is empty.

Variables

View Source
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

Returns the status of a previously submitted async or stored Event Query Language (EQL) search

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) 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) 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 added in v8.7.0

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

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

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 added in v8.7.0

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/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/eql/get_status/EqlGetStatusResponse.ts#L24-L51

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL