getasyncstatus

Documentation

Overview

Returns the current status of an async SQL search or a stored synchronous SQL search

Index

• Variables
• type GetAsyncStatus
  • func New(tp elastictransport.Interface) *GetAsyncStatus
  • func (r GetAsyncStatus) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetAsyncStatus) ErrorTrace(errortrace bool) *GetAsyncStatus
  • func (r *GetAsyncStatus) FilterPath(filterpaths ...string) *GetAsyncStatus
  • func (r *GetAsyncStatus) Header(key, value string) *GetAsyncStatus
  • func (r *GetAsyncStatus) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetAsyncStatus) Human(human bool) *GetAsyncStatus
  • func (r GetAsyncStatus) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetAsyncStatus) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetAsyncStatus) Pretty(pretty bool) *GetAsyncStatus
• type NewGetAsyncStatus
  • func NewGetAsyncStatusFunc(tp elastictransport.Interface) NewGetAsyncStatus
• type Response
  • func NewResponse() *Response

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.

Types

type GetAsyncStatus

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

func New

func New(tp elastictransport.Interface) *GetAsyncStatus

Returns the current status of an async SQL search or a stored synchronous SQL search

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

func (GetAsyncStatus) Do

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

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

func (*GetAsyncStatus) ErrorTrace

func (r *GetAsyncStatus) ErrorTrace(errortrace bool) *GetAsyncStatus

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

func (*GetAsyncStatus) FilterPath

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

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

func (*GetAsyncStatus) Header

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

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

func (*GetAsyncStatus) HttpRequest

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

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

func (*GetAsyncStatus) Human

func (r *GetAsyncStatus) Human(human bool) *GetAsyncStatus

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 (GetAsyncStatus) IsSuccess

func (r GetAsyncStatus) 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 (GetAsyncStatus) Perform

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

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

func (*GetAsyncStatus) Pretty

func (r *GetAsyncStatus) Pretty(pretty bool) *GetAsyncStatus

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

type NewGetAsyncStatus

type NewGetAsyncStatus func(id string) *GetAsyncStatus

NewGetAsyncStatus type alias for index.

func NewGetAsyncStatusFunc

func NewGetAsyncStatusFunc(tp elastictransport.Interface) NewGetAsyncStatus

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

type Response

type Response struct {

	// CompletionStatus HTTP status code for the search. The API only returns this property for
	// completed searches.
	CompletionStatus *uint `json:"completion_status,omitempty"`
	// ExpirationTimeInMillis Timestamp, in milliseconds since the Unix epoch, when Elasticsearch will
	// delete
	// the search and its results, even if the search is still running.
	ExpirationTimeInMillis int64 `json:"expiration_time_in_millis"`
	// Id Identifier for the search.
	Id string `json:"id"`
	// IsPartial If `true`, the response does not contain complete search results. If
	// `is_partial`
	// is `true` and `is_running` is `true`, the search is still running. If
	// `is_partial`
	// is `true` but `is_running` is `false`, the results are partial due to a
	// failure or
	// timeout.
	IsPartial bool `json:"is_partial"`
	// IsRunning If `true`, the search is still running. If `false`, the search has finished.
	IsRunning bool `json:"is_running"`
	// StartTimeInMillis Timestamp, in milliseconds since the Unix epoch, when the search started.
	// The API only returns this property for running searches.
	StartTimeInMillis int64 `json:"start_time_in_millis"`
}

Response holds the response body struct for the package getasyncstatus

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/sql/get_async_status/SqlGetAsyncStatusResponse.ts#L23-L55

func NewResponse

func NewResponse() *Response

NewResponse returns a Response