clearcursor

Documentation

Overview

Clear an SQL search cursor.

Index

• Variables
• type ClearCursor
  • func New(tp elastictransport.Interface) *ClearCursor
  • func (r *ClearCursor) Cursor(cursor string) *ClearCursor
  • func (r ClearCursor) Do(providedCtx context.Context) (*Response, error)
  • func (r *ClearCursor) ErrorTrace(errortrace bool) *ClearCursor
  • func (r *ClearCursor) FilterPath(filterpaths ...string) *ClearCursor
  • func (r *ClearCursor) Header(key, value string) *ClearCursor
  • func (r *ClearCursor) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ClearCursor) Human(human bool) *ClearCursor
  • func (r ClearCursor) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ClearCursor) Pretty(pretty bool) *ClearCursor
  • func (r *ClearCursor) Raw(raw io.Reader) *ClearCursor
  • func (r *ClearCursor) Request(req *Request) *ClearCursor
• type NewClearCursor
  • func NewClearCursorFunc(tp elastictransport.Interface) NewClearCursor
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response

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 ClearCursor

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

func New

func New(tp elastictransport.Interface) *ClearCursor

Clear an SQL search cursor.

https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html

func (*ClearCursor) Cursor

func (r *ClearCursor) Cursor(cursor string) *ClearCursor

Cursor Cursor to clear. API name: cursor

func (ClearCursor) Do

func (r ClearCursor) Do(providedCtx context.Context) (*Response, error)

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

func (*ClearCursor) ErrorTrace

func (r *ClearCursor) ErrorTrace(errortrace bool) *ClearCursor

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*ClearCursor) FilterPath

func (r *ClearCursor) FilterPath(filterpaths ...string) *ClearCursor

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*ClearCursor) Header

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

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

func (*ClearCursor) HttpRequest

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

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

func (*ClearCursor) Human

func (r *ClearCursor) Human(human bool) *ClearCursor

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (ClearCursor) Perform

func (r ClearCursor) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*ClearCursor) Pretty

func (r *ClearCursor) Pretty(pretty bool) *ClearCursor

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*ClearCursor) Raw

func (r *ClearCursor) Raw(raw io.Reader) *ClearCursor

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*ClearCursor) Request

func (r *ClearCursor) Request(req *Request) *ClearCursor

Request allows to set the request property with the appropriate payload.

type NewClearCursor

type NewClearCursor func() *ClearCursor

NewClearCursor type alias for index.

func NewClearCursorFunc

func NewClearCursorFunc(tp elastictransport.Interface) NewClearCursor

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

type Request

type Request struct {

	// Cursor Cursor to clear.
	Cursor string `json:"cursor"`
}

Request holds the request body struct for the package clearcursor

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/sql/clear_cursor/ClearSqlCursorRequest.ts#L22-L35

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {
	Succeeded bool `json:"succeeded"`
}

Response holds the response body struct for the package clearcursor

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/sql/clear_cursor/ClearSqlCursorResponse.ts#L20-L22

func NewResponse

func NewResponse() *Response

NewResponse returns a Response