info

Documentation

Overview

Retrieves information about the installed X-Pack features.

Index

• Variables
• type Info
  • func New(tp elastictransport.Interface) *Info
  • func (r *Info) AcceptEnterprise(b bool) *Info
  • func (r *Info) Categories(value string) *Info
  • func (r Info) Do(ctx context.Context) (*http.Response, error)
  • func (r *Info) Header(key, value string) *Info
  • func (r *Info) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Info) Human(b bool) *Info
  • func (r Info) IsSuccess(ctx context.Context) (bool, error)
• type NewInfo
  • func NewInfoFunc(tp elastictransport.Interface) NewInfo

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

Retrieves 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(b 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(value string) *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(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

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(b 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(ctx 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.

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.