revertmodelsnapshot

Documentation

Overview

Reverts to a specific snapshot.

Index

• Variables
• type NewRevertModelSnapshot
  • func NewRevertModelSnapshotFunc(tp elastictransport.Interface) NewRevertModelSnapshot
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) DeleteInterveningResults(deleteinterveningresults bool) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
• type RevertModelSnapshot
  • func New(tp elastictransport.Interface) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) DeleteInterveningResults(b bool) *RevertModelSnapshot
  • func (r RevertModelSnapshot) Do(ctx context.Context) (*http.Response, error)
  • func (r *RevertModelSnapshot) Header(key, value string) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *RevertModelSnapshot) JobId(v string) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) Raw(raw json.RawMessage) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) Request(req *Request) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) SnapshotId(v 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/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts#L23-L69

type RequestBuilder

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

RequestBuilder is the builder API for the revertmodelsnapshot.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) DeleteInterveningResults

func (rb *RequestBuilder) DeleteInterveningResults(deleteinterveningresults bool) *RequestBuilder

func (*RequestBuilder) FromJSON

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

FromJSON allows to load an arbitrary json into the request structure

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(b bool) *RevertModelSnapshot

DeleteInterveningResults If true, deletes the results in the time period between the latest results and the time of the reverted snapshot. It also resets the model to accept records for this time period. If you choose not to delete intervening results when reverting a snapshot, the job will not accept input data that is older than the current time. If you want to resend data, then delete the intervening results. API name: delete_intervening_results

func (RevertModelSnapshot) Do

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

Do runs the http.Request through the provided transport.

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

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

func (*RevertModelSnapshot) Raw

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