deprecations

package
v8.18.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 17, 2025 License: Apache-2.0 Imports: 11 Imported by: 4

Documentation

Overview

Get deprecation information. Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.

TIP: This APIs is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant.

Index

Constants

This section is empty.

Variables

View Source
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 Deprecations

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

func New

Get deprecation information. Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.

TIP: This APIs is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant.

https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html

func (Deprecations) Do

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

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

func (*Deprecations) ErrorTrace added in v8.14.0

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

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

func (*Deprecations) FilterPath added in v8.14.0

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

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

func (*Deprecations) Header

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

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

func (*Deprecations) HttpRequest

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

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

func (*Deprecations) Human added in v8.14.0

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

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 (*Deprecations) Index

func (r *Deprecations) Index(index string) *Deprecations

Index Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported. API Name: index

func (Deprecations) IsSuccess

func (r Deprecations) 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 (Deprecations) Perform added in v8.7.0

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

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

func (*Deprecations) Pretty added in v8.14.0

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

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

type NewDeprecations

type NewDeprecations func() *Deprecations

NewDeprecations type alias for index.

func NewDeprecationsFunc

func NewDeprecationsFunc(tp elastictransport.Interface) NewDeprecations

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

type Response added in v8.7.0

type Response struct {

	// ClusterSettings Cluster-level deprecation warnings.
	ClusterSettings []types.Deprecation            `json:"cluster_settings"`
	DataStreams     map[string][]types.Deprecation `json:"data_streams"`
	// IlmPolicies ILM policy warnings are sectioned off per policy.
	IlmPolicies map[string][]types.Deprecation `json:"ilm_policies"`
	// IndexSettings Index warnings are sectioned off per index and can be filtered using an
	// index-pattern in the query.
	// This section includes warnings for the backing indices of data streams
	// specified in the request path.
	IndexSettings map[string][]types.Deprecation `json:"index_settings"`
	// MlSettings Machine learning-related deprecation warnings.
	MlSettings []types.Deprecation `json:"ml_settings"`
	// NodeSettings Node-level deprecation warnings.
	// Since only a subset of your nodes might incorporate these settings, it is
	// important to read the details section for more information about which nodes
	// are affected.
	NodeSettings []types.Deprecation `json:"node_settings"`
	// Templates Template warnings are sectioned off per template and include deprecations for
	// both component templates and
	// index templates.
	Templates map[string][]types.Deprecation `json:"templates"`
}

Response holds the response body struct for the package deprecations

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/migration/deprecations/DeprecationInfoResponse.ts#L23-L54

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

close