updatemodelsnapshot

Documentation

Overview

Updates certain properties of a snapshot.

Index

• Variables
• type NewUpdateModelSnapshot
  • func NewUpdateModelSnapshotFunc(tp elastictransport.Interface) NewUpdateModelSnapshot
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) Description(description string) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Retain(retain bool) *RequestBuilder
• type UpdateModelSnapshot
  • func New(tp elastictransport.Interface) *UpdateModelSnapshot
  • func (r UpdateModelSnapshot) Do(ctx context.Context) (*http.Response, error)
  • func (r *UpdateModelSnapshot) Header(key, value string) *UpdateModelSnapshot
  • func (r *UpdateModelSnapshot) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *UpdateModelSnapshot) JobId(v string) *UpdateModelSnapshot
  • func (r *UpdateModelSnapshot) Raw(raw json.RawMessage) *UpdateModelSnapshot
  • func (r *UpdateModelSnapshot) Request(req *Request) *UpdateModelSnapshot
  • func (r *UpdateModelSnapshot) SnapshotId(v 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/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts#L23-L54

type RequestBuilder

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

RequestBuilder is the builder API for the updatemodelsnapshot.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) Description

func (rb *RequestBuilder) Description(description string) *RequestBuilder

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Retain

func (rb *RequestBuilder) Retain(retain bool) *RequestBuilder

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) Do

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

Do runs the http.Request through the provided transport.

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(v string) *UpdateModelSnapshot

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

func (*UpdateModelSnapshot) Raw

func (r *UpdateModelSnapshot) Raw(raw json.RawMessage) *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) SnapshotId

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

SnapshotId Identifier for the model snapshot. API Name: snapshotid