deleteexpireddata

Documentation

Overview

Delete expired ML data. Deletes all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted. You can limit the request to a single or set of anomaly detection jobs by using a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. You can delete expired data for all anomaly detection jobs by using _all, by specifying * as the <job_id>, or by omitting the <job_id>.

Index

• Variables
• type DeleteExpiredData
  • func New(tp elastictransport.Interface) *DeleteExpiredData
  • func (r DeleteExpiredData) Do(providedCtx context.Context) (*Response, error)
  • func (r *DeleteExpiredData) ErrorTrace(errortrace bool) *DeleteExpiredData
  • func (r *DeleteExpiredData) FilterPath(filterpaths ...string) *DeleteExpiredData
  • func (r *DeleteExpiredData) Header(key, value string) *DeleteExpiredData
  • func (r *DeleteExpiredData) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *DeleteExpiredData) Human(human bool) *DeleteExpiredData
  • func (r *DeleteExpiredData) JobId(jobid string) *DeleteExpiredData
  • func (r DeleteExpiredData) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *DeleteExpiredData) Pretty(pretty bool) *DeleteExpiredData
  • func (r *DeleteExpiredData) Raw(raw io.Reader) *DeleteExpiredData
  • func (r *DeleteExpiredData) Request(req *Request) *DeleteExpiredData
  • func (r *DeleteExpiredData) RequestsPerSecond(requestspersecond float32) *DeleteExpiredData
  • func (r *DeleteExpiredData) Timeout(duration types.Duration) *DeleteExpiredData
• type NewDeleteExpiredData
  • func NewDeleteExpiredDataFunc(tp elastictransport.Interface) NewDeleteExpiredData
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Response
  • func NewResponse() *Response

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 DeleteExpiredData

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

func New

func New(tp elastictransport.Interface) *DeleteExpiredData

Delete expired ML data. Deletes all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted. You can limit the request to a single or set of anomaly detection jobs by using a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. You can delete expired data for all anomaly detection jobs by using _all, by specifying * as the <job_id>, or by omitting the <job_id>.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html

func (DeleteExpiredData) Do

func (r DeleteExpiredData) Do(providedCtx context.Context) (*Response, error)

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

func (*DeleteExpiredData) ErrorTrace

func (r *DeleteExpiredData) ErrorTrace(errortrace bool) *DeleteExpiredData

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*DeleteExpiredData) FilterPath

func (r *DeleteExpiredData) FilterPath(filterpaths ...string) *DeleteExpiredData

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*DeleteExpiredData) Header

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

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

func (*DeleteExpiredData) HttpRequest

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

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

func (*DeleteExpiredData) Human

func (r *DeleteExpiredData) Human(human bool) *DeleteExpiredData

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*DeleteExpiredData) JobId

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

JobId Identifier for an anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. API Name: jobid

func (DeleteExpiredData) Perform

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

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

func (*DeleteExpiredData) Pretty

func (r *DeleteExpiredData) Pretty(pretty bool) *DeleteExpiredData

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*DeleteExpiredData) Raw

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

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

func (*DeleteExpiredData) Request

func (r *DeleteExpiredData) Request(req *Request) *DeleteExpiredData

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

func (*DeleteExpiredData) RequestsPerSecond

func (r *DeleteExpiredData) RequestsPerSecond(requestspersecond float32) *DeleteExpiredData

RequestsPerSecond The desired requests per second for the deletion processes. The default behavior is no throttling. API name: requests_per_second

func (*DeleteExpiredData) Timeout

func (r *DeleteExpiredData) Timeout(duration types.Duration) *DeleteExpiredData

Timeout How long can the underlying delete processes run until they are canceled. API name: timeout

type NewDeleteExpiredData

type NewDeleteExpiredData func() *DeleteExpiredData

NewDeleteExpiredData type alias for index.

func NewDeleteExpiredDataFunc

func NewDeleteExpiredDataFunc(tp elastictransport.Interface) NewDeleteExpiredData

NewDeleteExpiredDataFunc returns a new instance of DeleteExpiredData 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 {

	// RequestsPerSecond The desired requests per second for the deletion processes. The default
	// behavior is no throttling.
	RequestsPerSecond *float32 `json:"requests_per_second,omitempty"`
	// Timeout How long can the underlying delete processes run until they are canceled.
	Timeout types.Duration `json:"timeout,omitempty"`
}

Request holds the request body struct for the package deleteexpireddata

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts#L25-L73

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

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {
	Deleted bool `json:"deleted"`
}

Response holds the response body struct for the package deleteexpireddata

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/delete_expired_data/MlDeleteExpiredDataResponse.ts#L20-L22

func NewResponse

func NewResponse() *Response

NewResponse returns a Response