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 Response
  • func NewResponse() *Response
• type Status
  • func New(tp elastictransport.Interface) *Status
  • func (r Status) Do(ctx context.Context) (*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)
  • func (r Status) Perform(ctx context.Context) (*http.Response, 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 Response

type Response struct {
	CompletionStatus       *int                  `json:"completion_status,omitempty"`
	ExpirationTime         types.DateTime        `json:"expiration_time,omitempty"`
	ExpirationTimeInMillis int64                 `json:"expiration_time_in_millis"`
	Id                     *string               `json:"id,omitempty"`
	IsPartial              bool                  `json:"is_partial"`
	IsRunning              bool                  `json:"is_running"`
	Shards_                types.ShardStatistics `json:"_shards"`
	StartTime              types.DateTime        `json:"start_time,omitempty"`
	StartTimeInMillis      int64                 `json:"start_time_in_millis"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

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) (*Response, error)

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

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.

func (Status) Perform

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

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