deletescript
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Delete a script or search template.Deletes a stored script or search template.
Index¶
- Variables
- type DeleteScript
- func (r DeleteScript) Do(providedCtx context.Context) (*Response, error)
- func (r *DeleteScript) ErrorTrace(errortrace bool) *DeleteScript
- func (r *DeleteScript) FilterPath(filterpaths ...string) *DeleteScript
- func (r *DeleteScript) Header(key, value string) *DeleteScript
- func (r *DeleteScript) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *DeleteScript) Human(human bool) *DeleteScript
- func (r DeleteScript) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *DeleteScript) MasterTimeout(duration string) *DeleteScript
- func (r DeleteScript) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DeleteScript) Pretty(pretty bool) *DeleteScript
- func (r *DeleteScript) Timeout(duration string) *DeleteScript
- type NewDeleteScript
- 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¶
typeDeleteScript¶
type DeleteScript struct {// contains filtered or unexported fields}funcNew¶
func New(tpelastictransport.Interface) *DeleteScript
Delete a script or search template.Deletes a stored script or search template.
https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-stored-script-api.html
func (DeleteScript)Do¶
func (rDeleteScript) Do(providedCtxcontext.Context) (*Response,error)
Do runs the request through the transport, handle the response and returns a deletescript.Response
func (*DeleteScript)ErrorTrace¶added inv8.14.0
func (r *DeleteScript) ErrorTrace(errortracebool) *DeleteScript
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace
func (*DeleteScript)FilterPath¶added inv8.14.0
func (r *DeleteScript) FilterPath(filterpaths ...string) *DeleteScript
FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path
func (*DeleteScript)Header¶
func (r *DeleteScript) Header(key, valuestring) *DeleteScript
Header set a key, value pair in the DeleteScript headers map.
func (*DeleteScript)HttpRequest¶
HttpRequest returns the http.Request object built from thegiven parameters.
func (*DeleteScript)Human¶added inv8.14.0
func (r *DeleteScript) Human(humanbool) *DeleteScript
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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human
func (DeleteScript)IsSuccess¶
func (rDeleteScript) IsSuccess(providedCtxcontext.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 (*DeleteScript)MasterTimeout¶
func (r *DeleteScript) MasterTimeout(durationstring) *DeleteScript
MasterTimeout The period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails andreturns an error.It can also be set to `-1` to indicate that the request should never timeout.API name: master_timeout
func (DeleteScript)Perform¶added inv8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteScript)Pretty¶added inv8.14.0
func (r *DeleteScript) Pretty(prettybool) *DeleteScript
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty
func (*DeleteScript)Timeout¶
func (r *DeleteScript) Timeout(durationstring) *DeleteScript
Timeout The period to wait for a response.If no response is received before the timeout expires, the request fails andreturns an error.It can also be set to `-1` to indicate that the request should never timeout.API name: timeout
typeNewDeleteScript¶
type NewDeleteScript func(idstring) *DeleteScript
NewDeleteScript type alias for index.
funcNewDeleteScriptFunc¶
func NewDeleteScriptFunc(tpelastictransport.Interface)NewDeleteScript
NewDeleteScriptFunc returns a new instance of DeleteScript with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.