status

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

Retrieves the status of a previously submitted async search request given its ID.

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 NewStatus

type NewStatus func(id string) *Status

NewStatus type alias for index.

func NewStatusFunc

func NewStatusFunc(tp elastictransport.Interface) NewStatus

NewStatusFunc returns a new instance of Status 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 {

	// Clusters_ Metadata about clusters involved in the cross-cluster search.
	// Not shown for local-only searches.
	Clusters_ *types.ClusterStatistics `json:"_clusters,omitempty"`
	// CompletionStatus If the async search completed, this field shows the status code of the
	// search.
	// For example, 200 indicates that the async search was successfully completed.
	// 503 indicates that the async search was completed with an error.
	CompletionStatus *int `json:"completion_status,omitempty"`
	// CompletionTime Indicates when the async search completed. Only present
	// when the search has completed.
	CompletionTime         types.DateTime `json:"completion_time,omitempty"`
	CompletionTimeInMillis *int64         `json:"completion_time_in_millis,omitempty"`
	// ExpirationTime Indicates when the async search will expire.
	ExpirationTime         types.DateTime `json:"expiration_time,omitempty"`
	ExpirationTimeInMillis int64          `json:"expiration_time_in_millis"`
	Id                     *string        `json:"id,omitempty"`
	// IsPartial When the query is no longer running, this property indicates whether the
	// search failed or was successfully completed on all shards.
	// While the query is running, `is_partial` is always set to `true`.
	IsPartial bool `json:"is_partial"`
	// IsRunning Indicates whether the search is still running or has completed.
	// NOTE: If the search failed after some shards returned their results or the
	// node that is coordinating the async search dies, results may be partial even
	// though `is_running` is `false`.
	IsRunning bool `json:"is_running"`
	// Shards_ Indicates how many shards have run the query so far.
	Shards_           types.ShardStatistics `json:"_shards"`
	StartTime         types.DateTime        `json:"start_time,omitempty"`
	StartTimeInMillis int64                 `json:"start_time_in_millis"`
}

Response holds the response body struct for the package status

https://github.com/elastic/elasticsearch-specification/blob/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/async_search/status/AsyncSearchStatusResponse.ts#L39-L41

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

type Status

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

func New

Retrieves the status of a previously submitted async search request given its ID.

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

func (Status) Do

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

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

func (*Status) Header

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

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

func (*Status) HttpRequest

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

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

func (Status) IsSuccess

func (r Status) 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 (Status) Perform added in v8.7.0

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

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

Jump to

Keyboard shortcuts

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