Documentation
¶
Overview ¶
Reset the features. Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.
WARNING: Intended for development and testing use only. Do not reset features on a production cluster.
Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. This deletes all state information stored in system indices.
The response code is HTTP 200 if the state is successfully reset for all features. It is HTTP 500 if the reset operation failed for any feature.
Note that select features might provide a way to reset particular system indices. Using this API resets all features, both those that are built-in and implemented as plugins.
To list the features that will be affected, use the get features API.
IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.
Index ¶
- Variables
- type NewResetFeatures
- type 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
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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
Reset the features. Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.
WARNING: Intended for development and testing use only. Do not reset features on a production cluster.
Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. This deletes all state information stored in system indices.
The response code is HTTP 200 if the state is successfully reset for all features. It is HTTP 500 if the reset operation failed for any feature.
Note that select features might provide a way to reset particular system indices. Using this API resets all features, both those that are built-in and implemented as plugins.
To list the features that will be affected, use the get features API.
IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.
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 ¶ added in v8.14.0
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 ¶ added in v8.14.0
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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*ResetFeatures) Human ¶ added in v8.14.0
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 ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ResetFeatures) Pretty ¶ added in v8.14.0
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
Source Files