resetfeatures

Documentation

Overview

Resets the internal state of features, usually by deleting system indices

Index

• Variables
• type NewResetFeatures
  • func NewResetFeaturesFunc(tp elastictransport.Interface) NewResetFeatures
• type ResetFeatures
  • func New(tp elastictransport.Interface) *ResetFeatures
  • func (r ResetFeatures) Do(providedCtx context.Context) (*Response, error)
  • func (r *ResetFeatures) ErrorTrace(errortrace bool) *ResetFeatures
  • func (r *ResetFeatures) FilterPath(filterpaths ...string) *ResetFeatures
  • func (r *ResetFeatures) Header(key, value string) *ResetFeatures
  • func (r *ResetFeatures) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ResetFeatures) Human(human bool) *ResetFeatures
  • func (r ResetFeatures) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r ResetFeatures) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ResetFeatures) Pretty(pretty bool) *ResetFeatures
• 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 NewResetFeatures

type NewResetFeatures func() *ResetFeatures

NewResetFeatures type alias for index.

func NewResetFeaturesFunc

func NewResetFeaturesFunc(tp elastictransport.Interface) NewResetFeatures

NewResetFeaturesFunc returns a new instance of ResetFeatures with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type ResetFeatures

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

func New

func New(tp elastictransport.Interface) *ResetFeatures

Resets the internal state of features, usually by deleting system indices

https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html

func (ResetFeatures) Do

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

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

func (*ResetFeatures) ErrorTrace

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

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

func (*ResetFeatures) FilterPath

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

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

func (*ResetFeatures) Header

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

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

func (*ResetFeatures) HttpRequest

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

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

func (*ResetFeatures) Human

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

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 (ResetFeatures) IsSuccess

func (r ResetFeatures) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (ResetFeatures) Perform

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

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

func (*ResetFeatures) Pretty

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

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

type Response

type Response struct {
	Features []types.Feature `json:"features"`
}

Response holds the response body struct for the package resetfeatures

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/features/reset_features/ResetFeaturesResponse.ts#L22-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response