info

Documentation

Overview

Provides general information about the installed X-Pack features.

Index

• Variables
• type Info
  • func New(tp elastictransport.Interface) *Info
  • func (r *Info) AcceptEnterprise(acceptenterprise bool) *Info
  • func (r *Info) Categories(categories ...xpackcategory.XPackCategory) *Info
  • func (r Info) Do(providedCtx context.Context) (*Response, error)
  • func (r *Info) ErrorTrace(errortrace bool) *Info
  • func (r *Info) FilterPath(filterpaths ...string) *Info
  • func (r *Info) Header(key, value string) *Info
  • func (r *Info) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Info) Human(human bool) *Info
  • func (r Info) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Info) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Info) Pretty(pretty bool) *Info
• type NewInfo
  • func NewInfoFunc(tp elastictransport.Interface) NewInfo
• 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 Info

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

func New

func New(tp elastictransport.Interface) *Info

Provides general information about the installed X-Pack features.

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

func (*Info) AcceptEnterprise

func (r *Info) AcceptEnterprise(acceptenterprise bool) *Info

AcceptEnterprise If this param is used it must be set to true API name: accept_enterprise

func (*Info) Categories

func (r *Info) Categories(categories ...xpackcategory.XPackCategory) *Info

Categories A comma-separated list of the information categories to include in the response. For example, `build,license,features`. API name: categories

func (Info) Do

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

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

func (*Info) ErrorTrace

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

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

func (*Info) FilterPath

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

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

func (*Info) Header

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

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

func (*Info) HttpRequest

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

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

func (*Info) Human

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

Human Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. API name: human

func (Info) IsSuccess

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

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

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

func (*Info) Pretty

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

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

type NewInfo

type NewInfo func() *Info

NewInfo type alias for index.

func NewInfoFunc

func NewInfoFunc(tp elastictransport.Interface) NewInfo

NewInfoFunc returns a new instance of Info 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 {
	Build    types.BuildInformation          `json:"build"`
	Features types.XpackFeatures             `json:"features"`
	License  types.MinimalLicenseInformation `json:"license"`
	Tagline  string                          `json:"tagline"`
}

Response holds the response body struct for the package info

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/xpack/info/XPackInfoResponse.ts#L22-L29

func NewResponse

func NewResponse() *Response

NewResponse returns a Response