deprecations

Documentation

Overview

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

Index

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

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

func New

func New(tp elastictransport.Interface) *Deprecations

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

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

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

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

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

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

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

type Response struct {
	ClusterSettings []types.Deprecation            `json:"cluster_settings"`
	IndexSettings   map[string][]types.Deprecation `json:"index_settings"`
	MlSettings      []types.Deprecation            `json:"ml_settings"`
	NodeSettings    []types.Deprecation            `json:"node_settings"`
}

Response holds the response body struct for the package deprecations

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/migration/deprecations/DeprecationInfoResponse.ts#L23-L30

func NewResponse

func NewResponse() *Response

NewResponse returns a Response