clearcursor

Documentation

Overview

Clears the SQL cursor

Index

• Variables
• type ClearCursor
  • func New(tp elastictransport.Interface) *ClearCursor
  • func (r ClearCursor) Do(ctx context.Context) (*http.Response, error)
  • func (r *ClearCursor) Header(key, value string) *ClearCursor
  • func (r *ClearCursor) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ClearCursor) Raw(raw json.RawMessage) *ClearCursor
  • func (r *ClearCursor) Request(req *Request) *ClearCursor
• type NewClearCursor
  • func NewClearCursorFunc(tp elastictransport.Interface) NewClearCursor
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) Cursor(cursor string) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, 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 ClearCursor

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

func New

func New(tp elastictransport.Interface) *ClearCursor

Clears the SQL cursor

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

func (ClearCursor) Do

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

Do runs the http.Request through the provided transport.

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) Raw

func (r *ClearCursor) Raw(raw json.RawMessage) *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 string `json:"cursor"`
}

Request holds the request body struct for the package clearcursor

https://github.com/elastic/elasticsearch-specification/blob/1b56d7e58f5c59f05d1641c6d6a8117c5e01d741/specification/sql/clear_cursor/ClearSqlCursorRequest.ts#L22-L31

type RequestBuilder

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

RequestBuilder is the builder API for the clearcursor.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) Cursor

func (rb *RequestBuilder) Cursor(cursor string) *RequestBuilder

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure