revertmodelsnapshot

Documentation

Overview

Reverts to a specific snapshot.

Index

• Variables
• type NewRevertModelSnapshot
  • func NewRevertModelSnapshotFunc(tp elastictransport.Interface) NewRevertModelSnapshot
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type RevertModelSnapshot
  • func New(tp elastictransport.Interface) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) DeleteInterveningResults(deleteinterveningresults bool) *RevertModelSnapshot
  • func (r RevertModelSnapshot) Do(ctx context.Context) (*Response, error)
  • func (r *RevertModelSnapshot) Header(key, value string) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *RevertModelSnapshot) JobId(jobid string) *RevertModelSnapshot
  • func (r RevertModelSnapshot) Perform(ctx context.Context) (*http.Response, error)
  • func (r *RevertModelSnapshot) Raw(raw io.Reader) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) Request(req *Request) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) SnapshotId(snapshotid string) *RevertModelSnapshot

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 NewRevertModelSnapshot

type NewRevertModelSnapshot func(jobid, snapshotid string) *RevertModelSnapshot

NewRevertModelSnapshot type alias for index.

func NewRevertModelSnapshotFunc

func NewRevertModelSnapshotFunc(tp elastictransport.Interface) NewRevertModelSnapshot

NewRevertModelSnapshotFunc returns a new instance of RevertModelSnapshot 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 {

	// DeleteInterveningResults Refer to the description for the `delete_intervening_results` query
	// parameter.
	DeleteInterveningResults *bool `json:"delete_intervening_results,omitempty"`
}

Request holds the request body struct for the package revertmodelsnapshot

https://github.com/elastic/elasticsearch-specification/blob/3b09f9d8e90178243f8a340a7bc324aab152c602/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts#L23-L69

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type RevertModelSnapshot

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

func New

func New(tp elastictransport.Interface) *RevertModelSnapshot

Reverts to a specific snapshot.

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

func (*RevertModelSnapshot) DeleteInterveningResults

func (r *RevertModelSnapshot) DeleteInterveningResults(deleteinterveningresults bool) *RevertModelSnapshot

DeleteInterveningResults Refer to the description for the `delete_intervening_results` query parameter. API name: delete_intervening_results

func (RevertModelSnapshot) Do

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

Do runs the request through the transport, handle the response and returns a revertmodelsnapshot.Response

func (*RevertModelSnapshot) Header

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

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

func (*RevertModelSnapshot) HttpRequest

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

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

func (*RevertModelSnapshot) JobId

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

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

func (RevertModelSnapshot) Perform

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

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

func (*RevertModelSnapshot) Raw

func (r *RevertModelSnapshot) Raw(raw io.Reader) *RevertModelSnapshot

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*RevertModelSnapshot) Request

func (r *RevertModelSnapshot) Request(req *Request) *RevertModelSnapshot

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

func (*RevertModelSnapshot) SnapshotId

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

SnapshotId You can specify `empty` as the <snapshot_id>. Reverting to the empty snapshot means the anomaly detection job starts learning a new model from scratch when it is started. API Name: snapshotid