mltrainedmodels

Documentation

Overview

Gets configuration and usage information about inference trained models.

Index

• Variables
• type MlTrainedModels
  • func New(tp elastictransport.Interface) *MlTrainedModels
  • func (r *MlTrainedModels) AllowNoMatch(b bool) *MlTrainedModels
  • func (r *MlTrainedModels) Bytes(enum bytes.Bytes) *MlTrainedModels
  • func (r MlTrainedModels) Do(ctx context.Context) (Response, error)
  • func (r *MlTrainedModels) From(i int) *MlTrainedModels
  • func (r *MlTrainedModels) H(v string) *MlTrainedModels
  • func (r *MlTrainedModels) Header(key, value string) *MlTrainedModels
  • func (r *MlTrainedModels) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r MlTrainedModels) IsSuccess(ctx context.Context) (bool, error)
  • func (r *MlTrainedModels) ModelId(v string) *MlTrainedModels
  • func (r MlTrainedModels) Perform(ctx context.Context) (*http.Response, error)
  • func (r *MlTrainedModels) S(v string) *MlTrainedModels
  • func (r *MlTrainedModels) Size(i int) *MlTrainedModels
• type NewMlTrainedModels
  • func NewMlTrainedModelsFunc(tp elastictransport.Interface) NewMlTrainedModels
• type Response
  • func NewResponse() Response

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.

Types

type MlTrainedModels

type MlTrainedModels struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *MlTrainedModels

Gets configuration and usage information about inference trained models.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-trained-model.html

func (*MlTrainedModels) AllowNoMatch

func (r *MlTrainedModels) AllowNoMatch(b bool) *MlTrainedModels

AllowNoMatch Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) API name: allow_no_match

func (*MlTrainedModels) Bytes

func (r *MlTrainedModels) Bytes(enum bytes.Bytes) *MlTrainedModels

Bytes The unit in which to display byte values API name: bytes

func (MlTrainedModels) Do

func (r MlTrainedModels) Do(ctx context.Context) (Response, error)

Do runs the request through the transport, handle the response and returns a mltrainedmodels.Response

func (*MlTrainedModels) From

func (r *MlTrainedModels) From(i int) *MlTrainedModels

From skips a number of trained models API name: from

func (*MlTrainedModels) H

func (r *MlTrainedModels) H(v string) *MlTrainedModels

H Comma-separated list of column names to display API name: h

func (*MlTrainedModels) Header

func (r *MlTrainedModels) Header(key, value string) *MlTrainedModels

Header set a key, value pair in the MlTrainedModels headers map.

func (*MlTrainedModels) HttpRequest

func (r *MlTrainedModels) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (MlTrainedModels) IsSuccess

func (r MlTrainedModels) IsSuccess(ctx 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 (*MlTrainedModels) ModelId

func (r *MlTrainedModels) ModelId(v string) *MlTrainedModels

ModelId The ID of the trained models stats to fetch API Name: modelid

func (MlTrainedModels) Perform

func (r MlTrainedModels) Perform(ctx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*MlTrainedModels) S

func (r *MlTrainedModels) S(v string) *MlTrainedModels

S Comma-separated list of column names or column aliases to sort by API name: s

func (*MlTrainedModels) Size

func (r *MlTrainedModels) Size(i int) *MlTrainedModels

Size specifies a max number of trained models to get API name: size

type NewMlTrainedModels

type NewMlTrainedModels func() *MlTrainedModels

NewMlTrainedModels type alias for index.

func NewMlTrainedModelsFunc

func NewMlTrainedModelsFunc(tp elastictransport.Interface) NewMlTrainedModels

NewMlTrainedModelsFunc returns a new instance of MlTrainedModels with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Response

type Response []types.TrainedModelsRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response