Documentation
¶
Overview ¶
Deletes a script.
Index ¶
- Variables
- type DeleteScript
- func (r DeleteScript) Do(providedCtx context.Context) (*Response, error)
- func (r *DeleteScript) Header(key, value string) *DeleteScript
- func (r *DeleteScript) HttpRequest(ctx context.Context) (*http.Request, error)
- 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) 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 ¶
type DeleteScript ¶
type DeleteScript struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeleteScript
Deletes a script.
https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
func (DeleteScript) Do ¶
func (r DeleteScript) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a deletescript.Response
func (*DeleteScript) Header ¶
func (r *DeleteScript) Header(key, value string) *DeleteScript
Header set a key, value pair in the DeleteScript headers map.
func (*DeleteScript) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (DeleteScript) IsSuccess ¶
func (r DeleteScript) IsSuccess(providedCtx 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 (*DeleteScript) MasterTimeout ¶
func (r *DeleteScript) MasterTimeout(duration string) *DeleteScript
MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout
func (DeleteScript) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteScript) Timeout ¶
func (r *DeleteScript) Timeout(duration string) *DeleteScript
Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout
type NewDeleteScript ¶
type NewDeleteScript func(id string) *DeleteScript
NewDeleteScript type alias for index.
func NewDeleteScriptFunc ¶
func NewDeleteScriptFunc(tp elastictransport.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.
Source Files