Documentation
¶
Overview ¶
Update a snapshot. Updates certain properties of a snapshot.
Index ¶
- Variables
- type NewUpdateModelSnapshot
- type Request
- type Response
- type UpdateModelSnapshot
- func (r *UpdateModelSnapshot) Description(description string) *UpdateModelSnapshot
- func (r UpdateModelSnapshot) Do(providedCtx context.Context) (*Response, error)
- func (r *UpdateModelSnapshot) ErrorTrace(errortrace bool) *UpdateModelSnapshot
- func (r *UpdateModelSnapshot) FilterPath(filterpaths ...string) *UpdateModelSnapshot
- func (r *UpdateModelSnapshot) Header(key, value string) *UpdateModelSnapshot
- func (r *UpdateModelSnapshot) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *UpdateModelSnapshot) Human(human bool) *UpdateModelSnapshot
- func (r UpdateModelSnapshot) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *UpdateModelSnapshot) Pretty(pretty bool) *UpdateModelSnapshot
- func (r *UpdateModelSnapshot) Raw(raw io.Reader) *UpdateModelSnapshot
- func (r *UpdateModelSnapshot) Request(req *Request) *UpdateModelSnapshot
- func (r *UpdateModelSnapshot) Retain(retain bool) *UpdateModelSnapshot
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 NewUpdateModelSnapshot ¶
type NewUpdateModelSnapshot func(jobid, snapshotid string) *UpdateModelSnapshot
NewUpdateModelSnapshot type alias for index.
func NewUpdateModelSnapshotFunc ¶
func NewUpdateModelSnapshotFunc(tp elastictransport.Interface) NewUpdateModelSnapshot
NewUpdateModelSnapshotFunc returns a new instance of UpdateModelSnapshot with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Request ¶
type Request struct {
// Description A description of the model snapshot.
Description *string `json:"description,omitempty"`
// Retain If `true`, this snapshot will not be deleted during automatic cleanup of
// snapshots older than `model_snapshot_retention_days`. However, this
// snapshot will be deleted when the job is deleted.
Retain *bool `json:"retain,omitempty"`
}
Request holds the request body struct for the package updatemodelsnapshot
type Response ¶
type Response struct {
Acknowledged bool `json:"acknowledged"`
Model types.ModelSnapshot `json:"model"`
}
Response holds the response body struct for the package updatemodelsnapshot
type UpdateModelSnapshot ¶
type UpdateModelSnapshot struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *UpdateModelSnapshot
Update a snapshot. Updates certain properties of a snapshot.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-model-snapshot
func (*UpdateModelSnapshot) Description ¶
func (r *UpdateModelSnapshot) Description(description string) *UpdateModelSnapshot
A description of the model snapshot. API name: description
func (UpdateModelSnapshot) Do ¶
func (r UpdateModelSnapshot) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a updatemodelsnapshot.Response
func (*UpdateModelSnapshot) ErrorTrace ¶
func (r *UpdateModelSnapshot) ErrorTrace(errortrace bool) *UpdateModelSnapshot
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*UpdateModelSnapshot) FilterPath ¶
func (r *UpdateModelSnapshot) FilterPath(filterpaths ...string) *UpdateModelSnapshot
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*UpdateModelSnapshot) Header ¶
func (r *UpdateModelSnapshot) Header(key, value string) *UpdateModelSnapshot
Header set a key, value pair in the UpdateModelSnapshot headers map.
func (*UpdateModelSnapshot) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*UpdateModelSnapshot) Human ¶
func (r *UpdateModelSnapshot) Human(human bool) *UpdateModelSnapshot
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 (UpdateModelSnapshot) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*UpdateModelSnapshot) Pretty ¶
func (r *UpdateModelSnapshot) Pretty(pretty bool) *UpdateModelSnapshot
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*UpdateModelSnapshot) Raw ¶
func (r *UpdateModelSnapshot) Raw(raw io.Reader) *UpdateModelSnapshot
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*UpdateModelSnapshot) Request ¶
func (r *UpdateModelSnapshot) Request(req *Request) *UpdateModelSnapshot
Request allows to set the request property with the appropriate payload.
func (*UpdateModelSnapshot) Retain ¶
func (r *UpdateModelSnapshot) Retain(retain bool) *UpdateModelSnapshot
If `true`, this snapshot will not be deleted during automatic cleanup of snapshots older than `model_snapshot_retention_days`. However, this snapshot will be deleted when the job is deleted. API name: retain