deleteexpireddata

Documentation

Overview

Deletes expired and unused machine learning data.

Index

• Variables
• type DeleteExpiredData
  • func New(tp elastictransport.Interface) *DeleteExpiredData
  • func (r DeleteExpiredData) Do(ctx context.Context) (*http.Response, error)
  • func (r *DeleteExpiredData) Header(key, value string) *DeleteExpiredData
  • func (r *DeleteExpiredData) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *DeleteExpiredData) JobId(v string) *DeleteExpiredData
  • func (r *DeleteExpiredData) Raw(raw json.RawMessage) *DeleteExpiredData
  • func (r *DeleteExpiredData) Request(req *Request) *DeleteExpiredData
  • func (r *DeleteExpiredData) RequestsPerSecond(value string) *DeleteExpiredData
  • func (r *DeleteExpiredData) Timeout(value string) *DeleteExpiredData
• type NewDeleteExpiredData
  • func NewDeleteExpiredDataFunc(tp elastictransport.Interface) NewDeleteExpiredData
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) RequestsPerSecond(requestspersecond float32) *RequestBuilder
  • func (rb *RequestBuilder) Timeout(timeout *types.DurationBuilder) *RequestBuilder

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(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

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(v 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) Raw

func (r *DeleteExpiredData) Raw(raw json.RawMessage) *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(value string) *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(value string) *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/1b56d7e58f5c59f05d1641c6d6a8117c5e01d741/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts#L25-L72

type RequestBuilder

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

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

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

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) RequestsPerSecond

func (rb *RequestBuilder) RequestsPerSecond(requestspersecond float32) *RequestBuilder

func (*RequestBuilder) Timeout

func (rb *RequestBuilder) Timeout(timeout *types.DurationBuilder) *RequestBuilder