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

funcNew¶

func New(tpelastictransport.Interface) *Get

Get async search results.

Retrieve the results of a previously submitted asynchronous search request.If the Elasticsearch security features are enabled, access to the results ofa specific async search is restricted to the user or API key that submittedit.

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

func (Get)Do¶

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

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

func (*Get)ErrorTrace¶added inv8.14.0

func (r *Get) ErrorTrace(errortracebool) *Get

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

func (*Get)FilterPath¶added inv8.14.0

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

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

func (*Get)Header¶

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

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

func (*Get)HttpRequest¶

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

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

func (*Get)Human¶added inv8.14.0

func (r *Get) Human(humanbool) *Get

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 (Get)IsSuccess¶

func (rGet) 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 (*Get)KeepAlive¶

func (r *Get) KeepAlive(durationstring) *Get

KeepAlive The length of time that the async search should be available in the cluster.When not specified, the `keep_alive` set with the corresponding submit asyncrequest will be used.Otherwise, it is possible to override the value and extend the validity ofthe request.When this period expires, the search, if still running, is cancelled.If the search is completed, its saved results are deleted.API name: keep_alive

func (Get)Perform¶added inv8.7.0

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

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

func (*Get)Pretty¶added inv8.14.0

func (r *Get) Pretty(prettybool) *Get

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

func (*Get)TypedKeys¶

func (r *Get) TypedKeys(typedkeysbool) *Get

TypedKeys Specify whether aggregation and suggester names should be prefixed by theirrespective types in the responseAPI name: typed_keys

func (*Get)WaitForCompletionTimeout¶

func (r *Get) WaitForCompletionTimeout(durationstring) *Get

WaitForCompletionTimeout Specifies to wait for the search to be completed up until the providedtimeout.Final results will be returned if available before the timeout expires,otherwise the currently available results will be returned once the timeoutexpires.By default no timeout is set meaning that the currently available resultswill be returned without any additional wait.API name: wait_for_completion_timeout

type NewGet func(idstring) *Get

funcNewGetFunc¶

func NewGetFunc(tpelastictransport.Interface)NewGet

NewGetFunc returns a new instance of Get with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.

type Response struct {// 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"`Responsetypes.AsyncSearch `json:"response"`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