deleteexpireddata

Documentation

Overview

Deletes expired and unused machine learning data.

Index

• Variables
• type DeleteExpiredData
  • func New(tp elastictransport.Interface) *DeleteExpiredData
  • func (r DeleteExpiredData) Do(providedCtx context.Context) (*Response, error)
  • func (r *DeleteExpiredData) Header(key, value string) *DeleteExpiredData
  • func (r *DeleteExpiredData) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *DeleteExpiredData) JobId(jobid string) *DeleteExpiredData
  • func (r DeleteExpiredData) Perform(providedCtx context.Context) (*http.Response, error)
  • 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

Deletes expired and unused machine learning data.

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) 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) 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) 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/b2c13a00c152a97cb41193deda8ed9b37fd06796/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts#L25-L72

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/b2c13a00c152a97cb41193deda8ed9b37fd06796/specification/ml/delete_expired_data/MlDeleteExpiredDataResponse.ts#L20-L22

func NewResponse

func NewResponse() *Response

NewResponse returns a Response