Documentation
¶
Overview ¶
Returns the current status and available results for an async SQL search or stored synchronous SQL search
Index ¶
- Variables
- type GetAsync
- func (r *GetAsync) Delimiter(delimiter string) *GetAsync
- func (r GetAsync) Do(providedCtx context.Context) (*Response, error)
- func (r *GetAsync) Format(format string) *GetAsync
- func (r *GetAsync) Header(key, value string) *GetAsync
- func (r *GetAsync) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetAsync) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *GetAsync) KeepAlive(duration string) *GetAsync
- func (r GetAsync) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetAsync) WaitForCompletionTimeout(duration string) *GetAsync
- type NewGetAsync
- 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 GetAsync ¶
type GetAsync struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetAsync
Returns the current status and available results for an async SQL search or stored synchronous SQL search
https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-sql-search-api.html
func (*GetAsync) Delimiter ¶
Delimiter Separator for CSV results. The API only supports this parameter for CSV responses. API name: delimiter
func (GetAsync) Do ¶
Do runs the request through the transport, handle the response and returns a getasync.Response
func (*GetAsync) Format ¶
Format Format for the response. You must specify a format using this parameter or the Accept HTTP header. If you specify both, the API uses this parameter. API name: format
func (*GetAsync) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (GetAsync) 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 (*GetAsync) KeepAlive ¶
KeepAlive Retention period for the search and its results. Defaults to the `keep_alive` period for the original SQL search. API name: keep_alive
func (GetAsync) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetAsync) WaitForCompletionTimeout ¶
WaitForCompletionTimeout Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. API name: wait_for_completion_timeout
type NewGetAsync ¶
NewGetAsync type alias for index.
func NewGetAsyncFunc ¶
func NewGetAsyncFunc(tp elastictransport.Interface) NewGetAsync
NewGetAsyncFunc returns a new instance of GetAsync 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 {
// Columns Column headings for the search results. Each object is a column.
Columns []types.Column `json:"columns,omitempty"`
// Cursor Cursor for the next set of paginated results. For CSV, TSV, and
// TXT responses, this value is returned in the `Cursor` HTTP header.
Cursor *string `json:"cursor,omitempty"`
// Id Identifier for the search. This value is only returned for async and saved
// synchronous searches. For CSV, TSV, and TXT responses, this value is returned
// in the `Async-ID` HTTP header.
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. This value is only returned for async and saved synchronous
// searches.
// For CSV, TSV, and TXT responses, this value is returned in the
// `Async-partial` HTTP header.
IsPartial bool `json:"is_partial"`
// IsRunning If `true`, the search is still running. If false, the search has finished.
// This value is only returned for async and saved synchronous searches. For
// CSV, TSV, and TXT responses, this value is returned in the `Async-partial`
// HTTP header.
IsRunning bool `json:"is_running"`
// Rows Values for the search results.
Rows [][]json.RawMessage `json:"rows"`
}
Response holds the response body struct for the package getasync
Source Files