type NewUsage func() *Usage

funcNewUsageFunc¶

func NewUsageFunc(tpelastictransport.Interface)NewUsage

NewUsageFunc returns a new instance of Usage with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.

type Response struct {AggregateMetrictypes.Base                    `json:"aggregate_metric"`Analyticstypes.Analytics               `json:"analytics"`Archivetypes.Archive                 `json:"archive"`Ccrtypes.Ccr                     `json:"ccr"`DataFrame           *types.Base                   `json:"data_frame,omitempty"`DataScience         *types.Base                   `json:"data_science,omitempty"`DataStreams         *types.DataStreams            `json:"data_streams,omitempty"`DataTierstypes.DataTiers               `json:"data_tiers"`Enrich              *types.Base                   `json:"enrich,omitempty"`Eqltypes.Eql                     `json:"eql"`Flattened           *types.Flattened              `json:"flattened,omitempty"`FrozenIndicestypes.FrozenIndices           `json:"frozen_indices"`Graphtypes.Base                    `json:"graph"`HealthApi           *types.HealthStatistics       `json:"health_api,omitempty"`Ilmtypes.Ilm                     `json:"ilm"`Logstashtypes.Base                    `json:"logstash"`Mltypes.MachineLearning         `json:"ml"`Monitoringtypes.Monitoring              `json:"monitoring"`Rolluptypes.Base                    `json:"rollup"`RuntimeFields       *types.XpackRuntimeFieldTypes `json:"runtime_fields,omitempty"`SearchableSnapshotstypes.SearchableSnapshots     `json:"searchable_snapshots"`Securitytypes.Security                `json:"security"`Slmtypes.Slm                     `json:"slm"`Spatialtypes.Base                    `json:"spatial"`Sqltypes.Sql                     `json:"sql"`Transformtypes.Base                    `json:"transform"`Vectors             *types.Vector                 `json:"vectors,omitempty"`VotingOnlytypes.Base                    `json:"voting_only"`Watchertypes.Watcher                 `json:"watcher"`}

funcNewResponse¶added inv8.7.0

func NewResponse() *Response

NewResponse returns a Response

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

funcNew¶

func New(tpelastictransport.Interface) *Usage

Get usage information.Get information about the features that are currently enabled and availableunder the current license.The API also provides some usage statistics.

https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-xpack

func (Usage)Do¶

func (rUsage) Do(providedCtxcontext.Context) (*Response,error)

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

func (*Usage)ErrorTrace¶added inv8.14.0

func (r *Usage) ErrorTrace(errortracebool) *Usage

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

func (*Usage)FilterPath¶added inv8.14.0

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

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

func (*Usage)Header¶

func (r *Usage) Header(key, valuestring) *Usage

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

func (*Usage)HttpRequest¶

func (r *Usage) HttpRequest(ctxcontext.Context) (*http.Request,error)

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

func (*Usage)Human¶added inv8.14.0

func (r *Usage) Human(humanbool) *Usage

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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human

func (Usage)IsSuccess¶

func (rUsage) IsSuccess(providedCtxcontext.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 (*Usage)MasterTimeout¶

func (r *Usage) MasterTimeout(durationstring) *Usage

MasterTimeout The period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails andreturns an error.To indicate that the request should never timeout, set it to `-1`.API name: master_timeout

func (Usage)Perform¶added inv8.7.0

func (rUsage) Perform(providedCtxcontext.Context) (*http.Response,error)

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

func (*Usage)Pretty¶added inv8.14.0

func (r *Usage) Pretty(prettybool) *Usage

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