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(ctx context.Context) (*http.Response, error)
  • func (r *GetAsyncStatus) Header(key, value string) *GetAsyncStatus
  • func (r *GetAsyncStatus) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetAsyncStatus) Id(v string) *GetAsyncStatus
  • func (r GetAsyncStatus) IsSuccess(ctx context.Context) (bool, error)
• type NewGetAsyncStatus
  • func NewGetAsyncStatusFunc(tp elastictransport.Interface) NewGetAsyncStatus

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/master/get-async-sql-search-status-api.html

func (GetAsyncStatus) Do

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

Do runs the http.Request through the provided transport.

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

func (r *GetAsyncStatus) Id(v string) *GetAsyncStatus

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.

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.