The highest tagged major version is
Documentation
¶
Overview ¶
Delete model in the Inference API
Index ¶
- Variables
- type DeleteModel
- func (r DeleteModel) Do(providedCtx context.Context) (*Response, error)
- func (r *DeleteModel) ErrorTrace(errortrace bool) *DeleteModel
- func (r *DeleteModel) FilterPath(filterpaths ...string) *DeleteModel
- func (r *DeleteModel) Header(key, value string) *DeleteModel
- func (r *DeleteModel) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *DeleteModel) Human(human bool) *DeleteModel
- func (r DeleteModel) IsSuccess(providedCtx context.Context) (bool, error)
- func (r DeleteModel) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DeleteModel) Pretty(pretty bool) *DeleteModel
- func (r *DeleteModel) TaskType(tasktype string) *DeleteModel
- type NewDeleteModel
- 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 DeleteModel ¶
type DeleteModel struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeleteModel
Delete model in the Inference API
https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-inference-api.html
func (DeleteModel) Do ¶
func (r DeleteModel) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a deletemodel.Response
func (*DeleteModel) ErrorTrace ¶ added in v8.14.0
func (r *DeleteModel) ErrorTrace(errortrace bool) *DeleteModel
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*DeleteModel) FilterPath ¶ added in v8.14.0
func (r *DeleteModel) FilterPath(filterpaths ...string) *DeleteModel
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*DeleteModel) Header ¶
func (r *DeleteModel) Header(key, value string) *DeleteModel
Header set a key, value pair in the DeleteModel headers map.
func (*DeleteModel) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*DeleteModel) Human ¶ added in v8.14.0
func (r *DeleteModel) Human(human bool) *DeleteModel
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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
func (DeleteModel) IsSuccess ¶
func (r DeleteModel) 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 (DeleteModel) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteModel) Pretty ¶ added in v8.14.0
func (r *DeleteModel) Pretty(pretty bool) *DeleteModel
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*DeleteModel) TaskType ¶ added in v8.13.0
func (r *DeleteModel) TaskType(tasktype string) *DeleteModel
TaskType The task type API Name: tasktype
type NewDeleteModel ¶
type NewDeleteModel func(inferenceid string) *DeleteModel
NewDeleteModel type alias for index.
func NewDeleteModelFunc ¶
func NewDeleteModelFunc(tp elastictransport.Interface) NewDeleteModel
NewDeleteModelFunc returns a new instance of DeleteModel with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files