Documentation
¶
Overview ¶
Clears the SQL cursor
Index ¶
- Variables
- type ClearCursor
- func (r *ClearCursor) Cursor(cursor string) *ClearCursor
- func (r ClearCursor) Do(providedCtx context.Context) (*Response, error)
- func (r *ClearCursor) Header(key, value string) *ClearCursor
- func (r *ClearCursor) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r ClearCursor) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *ClearCursor) Raw(raw io.Reader) *ClearCursor
- func (r *ClearCursor) Request(req *Request) *ClearCursor
- type NewClearCursor
- type Request
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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) Cursor ¶ added in v8.9.0
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) Header ¶
func (r *ClearCursor) Header(key, value string) *ClearCursor
Header set a key, value pair in the ClearCursor headers map.
func (*ClearCursor) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (ClearCursor) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
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
Source Files