The highest tagged major version is
Documentation
¶
Overview ¶
Get the async search status.
Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, the access to the status of 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.
Index ¶
- Variables
- type NewStatus
- type Response
- type Status
- func (r Status) Do(providedCtx context.Context) (*Response, error)
- func (r *Status) ErrorTrace(errortrace bool) *Status
- func (r *Status) FilterPath(filterpaths ...string) *Status
- func (r *Status) Header(key, value string) *Status
- func (r *Status) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Status) Human(human bool) *Status
- func (r Status) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Status) KeepAlive(duration string) *Status
- func (r Status) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Status) Pretty(pretty bool) *Status
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 NewStatus ¶
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.
// 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.
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.
//
// > 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`.
IsRunning bool `json:"is_running"`
// Shards_ The number of shards that 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
func (*Response) UnmarshalJSON ¶ added in v8.15.0
type Status ¶
type Status struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Status
Get the async search status.
Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, the access to the status of 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 ¶
Do runs the request through the transport, handle the response and returns a status.Response
func (*Status) 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 (*Status) 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 (*Status) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Status) 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 (Status) 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 (*Status) KeepAlive ¶ added in v8.17.0
KeepAlive The length of time that the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period. API name: keep_alive
Source Files