updatemodelsnapshot

Documentation

Overview

Updates certain properties of a snapshot.

Index

• Variables
• type NewUpdateModelSnapshot
  • func NewUpdateModelSnapshotFunc(tp elastictransport.Interface) NewUpdateModelSnapshot
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type UpdateModelSnapshot
  • func New(tp elastictransport.Interface) *UpdateModelSnapshot
  • func (r *UpdateModelSnapshot) Description(description string) *UpdateModelSnapshot
  • func (r UpdateModelSnapshot) Do(ctx context.Context) (*Response, error)
  • func (r *UpdateModelSnapshot) Header(key, value string) *UpdateModelSnapshot
  • func (r *UpdateModelSnapshot) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *UpdateModelSnapshot) JobId(jobid string) *UpdateModelSnapshot
  • func (r UpdateModelSnapshot) Perform(ctx context.Context) (*http.Response, error)
  • func (r *UpdateModelSnapshot) Raw(raw io.Reader) *UpdateModelSnapshot
  • func (r *UpdateModelSnapshot) Request(req *Request) *UpdateModelSnapshot
  • func (r *UpdateModelSnapshot) Retain(retain bool) *UpdateModelSnapshot
  • func (r *UpdateModelSnapshot) SnapshotId(snapshotid string) *UpdateModelSnapshot

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 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/3b09f9d8e90178243f8a340a7bc324aab152c602/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts#L23-L54

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 bool                `json:"acknowledged"`
	Model        types.ModelSnapshot `json:"model"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type UpdateModelSnapshot

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

func New

func New(tp elastictransport.Interface) *UpdateModelSnapshot

Updates certain properties of a snapshot.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html

func (*UpdateModelSnapshot) Description

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

Description A description of the model snapshot. API name: description

func (UpdateModelSnapshot) Do

func (r UpdateModelSnapshot) Do(ctx 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) JobId

func (r *UpdateModelSnapshot) JobId(jobid string) *UpdateModelSnapshot

JobId Identifier for the anomaly detection job. API Name: jobid

func (UpdateModelSnapshot) Perform

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

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

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

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

func (*UpdateModelSnapshot) SnapshotId

func (r *UpdateModelSnapshot) SnapshotId(snapshotid string) *UpdateModelSnapshot

SnapshotId Identifier for the model snapshot. API Name: snapshotid