getfeatures

Documentation

Overview

Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot

Index

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

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

func New

func New(tp elastictransport.Interface) *GetFeatures

Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot

https://www.elastic.co/guide/en/elasticsearch/reference/current/get-features-api.html

func (GetFeatures) Do

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

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

func (*GetFeatures) ErrorTrace

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

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

func (*GetFeatures) FilterPath

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

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

func (*GetFeatures) Header

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

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

func (*GetFeatures) HttpRequest

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

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

func (*GetFeatures) Human

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

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

func (r GetFeatures) 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 (GetFeatures) Perform

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

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

func (*GetFeatures) Pretty

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

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

type NewGetFeatures

type NewGetFeatures func() *GetFeatures

NewGetFeatures type alias for index.

func NewGetFeaturesFunc

func NewGetFeaturesFunc(tp elastictransport.Interface) NewGetFeatures

NewGetFeaturesFunc returns a new instance of GetFeatures 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 {
	Features []types.Feature `json:"features"`
}

Response holds the response body struct for the package getfeatures

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response