Documentation
¶
Overview ¶
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 of a specific async search is restricted to the user or API key that submitted it.
Index ¶
- Variables
- type Get
- func (r Get) Do(providedCtx context.Context) (*Response, error)
- func (r *Get) ErrorTrace(errortrace bool) *Get
- func (r *Get) FilterPath(filterpaths ...string) *Get
- func (r *Get) Header(key, value string) *Get
- func (r *Get) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Get) Human(human bool) *Get
- func (r Get) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Get) KeepAlive(duration string) *Get
- func (r Get) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Get) Pretty(pretty bool) *Get
- func (r *Get) TypedKeys(typedkeys bool) *Get
- func (r *Get) WaitForCompletionTimeout(duration string) *Get
- type NewGet
- 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 Get ¶
type Get struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.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 of a specific async search is restricted to the user or API key that submitted it.
https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
func (Get) Do ¶
Do runs the request through the transport, handle the response and returns a get.Response
func (*Get) ErrorTrace ¶ added in v8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Get) FilterPath ¶ added in v8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Get) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Get) Human ¶ added in v8.14.0
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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
func (Get) IsSuccess ¶
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 ¶
KeepAlive Specifies how long the async search should be available in the cluster. When not specified, the `keep_alive` set with the corresponding submit async request will be used. Otherwise, it is possible to override the value and extend the validity of the 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 in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Get) Pretty ¶ added in v8.14.0
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*Get) TypedKeys ¶
TypedKeys Specify whether aggregation and suggester names should be prefixed by their respective types in the response API name: typed_keys
func (*Get) WaitForCompletionTimeout ¶
WaitForCompletionTimeout Specifies to wait for the search to be completed up until the provided timeout. Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. By default no timeout is set meaning that the currently available results will be returned without any additional wait. API name: wait_for_completion_timeout
type NewGet ¶
NewGet type alias for index.
func NewGetFunc ¶
func NewGetFunc(tp elastictransport.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 ¶ added in v8.7.0
type Response struct {
// 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"`
Response types.AsyncSearch `json:"response"`
StartTime types.DateTime `json:"start_time,omitempty"`
StartTimeInMillis int64 `json:"start_time_in_millis"`
}
Response holds the response body struct for the package get
Source Files