Documentation
¶
Overview ¶
Retrieves information about the installed X-Pack features.
Index ¶
- Variables
- type Info
- func (r *Info) AcceptEnterprise(acceptenterprise bool) *Info
- func (r *Info) Categories(categories ...string) *Info
- func (r Info) Do(providedCtx context.Context) (*Response, error)
- 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)
- type NewInfo
- 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 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 ¶
AcceptEnterprise If this param is used it must be set to true API name: accept_enterprise
func (*Info) Categories ¶
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 ¶
Do runs the request through the transport, handle the response and returns a info.Response
func (*Info) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Info) Human ¶
Human Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. API name: human
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 ¶ added in v8.7.0
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
Source Files