The highest tagged major version isv9.
delete
package
This 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
Open Source Insights
Documentation¶
Overview¶
Delete an inference endpoint
Index¶
- Variables
- type Delete
- func (r Delete) Do(providedCtx context.Context) (*Response, error)
- func (r *Delete) DryRun(dryrun bool) *Delete
- func (r *Delete) ErrorTrace(errortrace bool) *Delete
- func (r *Delete) FilterPath(filterpaths ...string) *Delete
- func (r *Delete) Force(force bool) *Delete
- func (r *Delete) Header(key, value string) *Delete
- func (r *Delete) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Delete) Human(human bool) *Delete
- func (r Delete) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Delete) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Delete) Pretty(pretty bool) *Delete
- func (r *Delete) TaskType(tasktype string) *Delete
- type NewDelete
- 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¶
typeDelete¶
type Delete struct {// contains filtered or unexported fields}funcNew¶
func New(tpelastictransport.Interface) *Delete
Delete an inference endpoint
https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-inference-api.html
func (Delete)Do¶
Do runs the request through the transport, handle the response and returns a delete.Response
func (*Delete)DryRun¶
DryRun When true, the endpoint is not deleted and a list of ingest processors whichreference this endpoint is returned.API name: dry_run
func (*Delete)ErrorTrace¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace
func (*Delete)FilterPath¶
FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path
func (*Delete)Force¶
Force When true, the inference endpoint is forcefully deleted even if it is stillbeing used by ingest processors or semantic text fields.API name: force
func (*Delete)HttpRequest¶
HttpRequest returns the http.Request object built from thegiven parameters.
func (*Delete)Human¶
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 (Delete)IsSuccess¶
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 (Delete)Perform¶
Perform runs the http.Request through the provided transport and returns an http.Response.
typeNewDelete¶
NewDelete type alias for index.
funcNewDeleteFunc¶
func NewDeleteFunc(tpelastictransport.Interface)NewDelete
NewDeleteFunc returns a new instance of Delete with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.
Source Files