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 (r Deprecations) Do(ctx context.Context) (*Response, error)
- func (r *Deprecations) Header(key, value string) *Deprecations
- func (r *Deprecations) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Deprecations) Index(v string) *Deprecations
- func (r Deprecations) IsSuccess(ctx context.Context) (bool, error)
- func (r Deprecations) Perform(ctx context.Context) (*http.Response, error)
- type NewDeprecations
- 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 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(ctx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a deprecations.Response
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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Deprecations) Index ¶
func (r *Deprecations) Index(v string) *Deprecations
Index Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported. API Name: index
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"` }