Documentation
¶
Overview ¶
Creates part of a trained model definition
Index ¶
- Variables
- type NewPutTrainedModelDefinitionPart
- type PutTrainedModelDefinitionPart
- func (r *PutTrainedModelDefinitionPart) Definition(definition string) *PutTrainedModelDefinitionPart
- func (r PutTrainedModelDefinitionPart) Do(providedCtx context.Context) (*Response, error)
- func (r *PutTrainedModelDefinitionPart) Header(key, value string) *PutTrainedModelDefinitionPart
- func (r *PutTrainedModelDefinitionPart) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r PutTrainedModelDefinitionPart) Perform(providedCtx context.Context) (*http.Response, error)
- 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
- 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 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
Creates part of a trained model definition
func (*PutTrainedModelDefinitionPart) Definition ¶ added in v8.9.0
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) Header ¶
func (r *PutTrainedModelDefinitionPart) Header(key, value string) *PutTrainedModelDefinitionPart
Header set a key, value pair in the PutTrainedModelDefinitionPart headers map.
func (*PutTrainedModelDefinitionPart) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (PutTrainedModelDefinitionPart) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
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 ¶ added in v8.9.0
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 ¶ added in v8.9.0
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
type Response ¶ added in v8.7.0
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
Source Files