get

Documentation

Overview

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

Index

• Variables
• type Get
  • func New(tp elastictransport.Interface) *Get
  • func (r Get) Do(ctx context.Context) (*http.Response, error)
  • func (r *Get) Header(key, value string) *Get
  • func (r *Get) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Get) Id(v string) *Get
  • func (r Get) IsSuccess(ctx context.Context) (bool, error)
  • func (r *Get) KeepAlive(value string) *Get
  • func (r *Get) TypedKeys(b bool) *Get
  • func (r *Get) WaitForCompletionTimeout(value string) *Get
• type NewGet
  • func NewGetFunc(tp elastictransport.Interface) NewGet

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 Get

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

func New

func New(tp elastictransport.Interface) *Get

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

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

func (Get) Do

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

Do runs the http.Request through the provided transport.

func (*Get) Header

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

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

func (*Get) HttpRequest

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

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

func (*Get) Id

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

Id The async search ID API Name: id

func (Get) IsSuccess

func (r Get) 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 (*Get) KeepAlive

func (r *Get) KeepAlive(value string) *Get

KeepAlive Specify the time interval in which the results (partial or final) for this search will be available API name: keep_alive

func (*Get) TypedKeys

func (r *Get) TypedKeys(b bool) *Get

TypedKeys Specify whether aggregation and suggester names should be prefixed by their respective types in the response API name: typed_keys

func (*Get) WaitForCompletionTimeout

func (r *Get) WaitForCompletionTimeout(value string) *Get

WaitForCompletionTimeout Specify the time that the request should block waiting for the final response API name: wait_for_completion_timeout

type NewGet

type NewGet func(id string) *Get

NewGet type alias for index.

func NewGetFunc

func NewGetFunc(tp elastictransport.Interface) NewGet

NewGetFunc returns a new instance of Get with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.