status

Documentation

Overview

Retrieves the status of a previously submitted async search request given its ID.

Index

• Variables
• type NewStatus
  • func NewStatusFunc(tp elastictransport.Interface) NewStatus
• type Status
  • func New(tp elastictransport.Interface) *Status
  • func (r Status) Do(ctx context.Context) (*http.Response, error)
  • func (r *Status) Header(key, value string) *Status
  • func (r *Status) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Status) Id(v string) *Status
  • func (r Status) IsSuccess(ctx context.Context) (bool, error)

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 NewStatus

type NewStatus func(id string) *Status

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 Status

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

func New

func New(tp elastictransport.Interface) *Status

Retrieves the status of a previously submitted async search request given its ID.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html

func (Status) Do

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

Do runs the http.Request through the provided transport.

func (*Status) Header

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

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

func (*Status) HttpRequest

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

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

func (*Status) Id

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

Id The async search ID API Name: id

func (Status) IsSuccess

func (r Status) 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.