type NewStatus func(idstring) *Status

funcNewStatusFunc¶

func NewStatusFunc(tpelastictransport.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 struct {// Clusters_ Metadata about clusters involved in the cross-cluster search.// It is 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.// It is present only when the search has completed.CompletionTimetypes.DateTime `json:"completion_time,omitempty"`CompletionTimeInMillis *int64         `json:"completion_time_in_millis,omitempty"`// ExpirationTime Indicates when the async search will expire.ExpirationTimetypes.DateTime `json:"expiration_time,omitempty"`ExpirationTimeInMillisint64          `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`.IsPartialbool `json:"is_partial"`// IsRunning Indicates whether the search is still running or has completed.//// > info// > 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`.IsRunningbool `json:"is_running"`// Shards_ The number of shards that have run the query so far.Shards_types.ShardStatistics `json:"_shards"`StartTimetypes.DateTime        `json:"start_time,omitempty"`StartTimeInMillisint64                 `json:"start_time_in_millis"`}

funcNewResponse¶added inv8.7.0

func NewResponse() *Response

NewResponse returns a Response

func (*Response)UnmarshalJSON¶added inv8.15.0

func (s *Response) UnmarshalJSON(data []byte)error

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

funcNew¶

func New(tpelastictransport.Interface) *Status

Get the async search status.

Get the status of a previously submitted async search request given itsidentifier, without retrieving search results.If the Elasticsearch security features are enabled, the access to the statusof a specific async search is restricted to:

* The user or API key that submitted the original async search request.* Users that have the `monitor` cluster privilege or greater privileges.

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

func (Status)Do¶

func (rStatus) Do(providedCtxcontext.Context) (*Response,error)

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

func (*Status)ErrorTrace¶added inv8.14.0

func (r *Status) ErrorTrace(errortracebool) *Status

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

func (*Status)FilterPath¶added inv8.14.0

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

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

func (*Status)Header¶

func (r *Status) Header(key, valuestring) *Status

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

func (*Status)HttpRequest¶

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

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

func (*Status)Human¶added inv8.14.0

func (r *Status) Human(humanbool) *Status

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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human

func (Status)IsSuccess¶

func (rStatus) IsSuccess(providedCtxcontext.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)KeepAlive¶added inv8.17.0

func (r *Status) KeepAlive(durationstring) *Status

KeepAlive The length of time that the async search needs to be available.Ongoing async searches and any saved search results are deleted after thisperiod.API name: keep_alive

func (Status)Perform¶added inv8.7.0

func (rStatus) Perform(providedCtxcontext.Context) (*http.Response,error)

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

func (*Status)Pretty¶added inv8.14.0

func (r *Status) Pretty(prettybool) *Status

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