puttrainedmodeldefinitionpart

Documentation

Overview

Create part of a trained model definition.

Index

• Variables
• type NewPutTrainedModelDefinitionPart
  • func NewPutTrainedModelDefinitionPartFunc(tp elastictransport.Interface) NewPutTrainedModelDefinitionPart
• type PutTrainedModelDefinitionPart
  • func New(tp elastictransport.Interface) *PutTrainedModelDefinitionPart
  • func (r *PutTrainedModelDefinitionPart) Definition(definition string) *PutTrainedModelDefinitionPart
  • func (r PutTrainedModelDefinitionPart) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutTrainedModelDefinitionPart) ErrorTrace(errortrace bool) *PutTrainedModelDefinitionPart
  • func (r *PutTrainedModelDefinitionPart) FilterPath(filterpaths ...string) *PutTrainedModelDefinitionPart
  • func (r *PutTrainedModelDefinitionPart) Header(key, value string) *PutTrainedModelDefinitionPart
  • func (r *PutTrainedModelDefinitionPart) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutTrainedModelDefinitionPart) Human(human bool) *PutTrainedModelDefinitionPart
  • func (r PutTrainedModelDefinitionPart) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutTrainedModelDefinitionPart) Pretty(pretty bool) *PutTrainedModelDefinitionPart
  • func (r *PutTrainedModelDefinitionPart) Raw(raw io.Reader) *PutTrainedModelDefinitionPart
  • func (r *PutTrainedModelDefinitionPart) Request(req *Request) *PutTrainedModelDefinitionPart
  • func (r *PutTrainedModelDefinitionPart) TotalDefinitionLength(totaldefinitionlength int64) *PutTrainedModelDefinitionPart
  • func (r *PutTrainedModelDefinitionPart) TotalParts(totalparts int) *PutTrainedModelDefinitionPart
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• 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 NewPutTrainedModelDefinitionPart

type NewPutTrainedModelDefinitionPart func(modelid, part string) *PutTrainedModelDefinitionPart

NewPutTrainedModelDefinitionPart type alias for index.

func NewPutTrainedModelDefinitionPartFunc

func NewPutTrainedModelDefinitionPartFunc(tp elastictransport.Interface) NewPutTrainedModelDefinitionPart

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

type PutTrainedModelDefinitionPart

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

func New

func New(tp elastictransport.Interface) *PutTrainedModelDefinitionPart

Create part of a trained model definition.

https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html

func (*PutTrainedModelDefinitionPart) Definition

func (r *PutTrainedModelDefinitionPart) Definition(definition string) *PutTrainedModelDefinitionPart

Definition The definition part for the model. Must be a base64 encoded string. API name: definition

func (PutTrainedModelDefinitionPart) Do

func (r PutTrainedModelDefinitionPart) Do(providedCtx context.Context) (*Response, error)

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

func (*PutTrainedModelDefinitionPart) ErrorTrace

func (r *PutTrainedModelDefinitionPart) ErrorTrace(errortrace bool) *PutTrainedModelDefinitionPart

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*PutTrainedModelDefinitionPart) FilterPath

func (r *PutTrainedModelDefinitionPart) FilterPath(filterpaths ...string) *PutTrainedModelDefinitionPart

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*PutTrainedModelDefinitionPart) Header

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

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

func (*PutTrainedModelDefinitionPart) HttpRequest

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

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

func (*PutTrainedModelDefinitionPart) Human

func (r *PutTrainedModelDefinitionPart) Human(human bool) *PutTrainedModelDefinitionPart

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 (PutTrainedModelDefinitionPart) Perform

func (r PutTrainedModelDefinitionPart) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*PutTrainedModelDefinitionPart) Pretty

func (r *PutTrainedModelDefinitionPart) Pretty(pretty bool) *PutTrainedModelDefinitionPart

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*PutTrainedModelDefinitionPart) Raw

func (r *PutTrainedModelDefinitionPart) Raw(raw io.Reader) *PutTrainedModelDefinitionPart

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*PutTrainedModelDefinitionPart) Request

func (r *PutTrainedModelDefinitionPart) Request(req *Request) *PutTrainedModelDefinitionPart

Request allows to set the request property with the appropriate payload.

func (*PutTrainedModelDefinitionPart) TotalDefinitionLength

func (r *PutTrainedModelDefinitionPart) TotalDefinitionLength(totaldefinitionlength int64) *PutTrainedModelDefinitionPart

TotalDefinitionLength The total uncompressed definition length in bytes. Not base64 encoded. API name: total_definition_length

func (*PutTrainedModelDefinitionPart) TotalParts

func (r *PutTrainedModelDefinitionPart) TotalParts(totalparts int) *PutTrainedModelDefinitionPart

TotalParts The total number of parts that will be uploaded. Must be greater than 0. API name: total_parts

type Request

type Request struct {

	// Definition The definition part for the model. Must be a base64 encoded string.
	Definition string `json:"definition"`
	// TotalDefinitionLength The total uncompressed definition length in bytes. Not base64 encoded.
	TotalDefinitionLength int64 `json:"total_definition_length"`
	// TotalParts The total number of parts that will be uploaded. Must be greater than 0.
	TotalParts int `json:"total_parts"`
}

Request holds the request body struct for the package puttrainedmodeldefinitionpart

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts#L24-L58

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package puttrainedmodeldefinitionpart

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response