getasyncstatus

package
v8.8.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 5, 2023 License: Apache-2.0 Imports: 12 Imported by: 4

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

View Source
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 GetAsyncStatus

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

func New

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

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

func (GetAsyncStatus) Do

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

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) Id

Id The async search ID API Name: id

func (GetAsyncStatus) IsSuccess

func (r GetAsyncStatus) IsSuccess(ctx 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 added in v8.7.0

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

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

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 added in v8.7.0

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"`
}

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL