updatemodelsnapshot

package
v8.13.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2024 License: Apache-2.0 Imports: 11 Imported by: 3

Documentation

Overview

Updates certain properties of a snapshot.

Index

Constants

This section is empty.

Variables

View Source
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

https://github.com/elastic/elasticsearch-specification/blob/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts#L23-L54

func NewRequest added in v8.5.0

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0

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

FromJSON allows to load an arbitrary json into the request structure

type Response added in v8.7.0

type Response struct {
	Acknowledged bool                `json:"acknowledged"`
	Model        types.ModelSnapshot `json:"model"`
}

Response holds the response body struct for the package updatemodelsnapshot

https://github.com/elastic/elasticsearch-specification/blob/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/ml/update_model_snapshot/MlUpdateModelSnapshotResponse.ts#L22-L27

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

type UpdateModelSnapshot

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

func (*UpdateModelSnapshot) Description added in v8.9.0

func (r *UpdateModelSnapshot) Description(description string) *UpdateModelSnapshot

Description 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) Header

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

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

func (*UpdateModelSnapshot) HttpRequest

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

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

func (UpdateModelSnapshot) Perform added in v8.7.0

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

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

func (*UpdateModelSnapshot) Raw

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

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

func (*UpdateModelSnapshot) Retain added in v8.9.0

func (r *UpdateModelSnapshot) Retain(retain bool) *UpdateModelSnapshot

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. API name: retain

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL