The highest tagged major version is
Documentation
¶
Overview ¶
Retrieves usage information about the installed X-Pack features.
Index ¶
- Variables
- type NewUsage
- type Response
- type Usage
- func (r Usage) Do(providedCtx context.Context) (*Response, error)
- func (r *Usage) ErrorTrace(errortrace bool) *Usage
- func (r *Usage) FilterPath(filterpaths ...string) *Usage
- func (r *Usage) Header(key, value string) *Usage
- func (r *Usage) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Usage) Human(human bool) *Usage
- func (r Usage) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Usage) MasterTimeout(duration string) *Usage
- func (r Usage) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Usage) Pretty(pretty bool) *Usage
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 NewUsage ¶
type NewUsage func() *Usage
NewUsage type alias for index.
func NewUsageFunc ¶
func NewUsageFunc(tp elastictransport.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 ¶ added in v8.7.0
type Response struct {
AggregateMetric types.Base `json:"aggregate_metric"`
Analytics types.Analytics `json:"analytics"`
Archive types.Archive `json:"archive"`
Ccr types.Ccr `json:"ccr"`
DataFrame *types.Base `json:"data_frame,omitempty"`
DataScience *types.Base `json:"data_science,omitempty"`
DataStreams *types.DataStreams `json:"data_streams,omitempty"`
DataTiers types.DataTiers `json:"data_tiers"`
Enrich *types.Base `json:"enrich,omitempty"`
Eql types.Eql `json:"eql"`
Flattened *types.Flattened `json:"flattened,omitempty"`
FrozenIndices types.FrozenIndices `json:"frozen_indices"`
Graph types.Base `json:"graph"`
HealthApi *types.HealthStatistics `json:"health_api,omitempty"`
Ilm types.Ilm `json:"ilm"`
Logstash types.Base `json:"logstash"`
Ml types.MachineLearning `json:"ml"`
Monitoring types.Monitoring `json:"monitoring"`
Rollup types.Base `json:"rollup"`
RuntimeFields *types.XpackRuntimeFieldTypes `json:"runtime_fields,omitempty"`
SearchableSnapshots types.SearchableSnapshots `json:"searchable_snapshots"`
Security types.Security `json:"security"`
Slm types.Slm `json:"slm"`
Spatial types.Base `json:"spatial"`
Sql types.Sql `json:"sql"`
Transform types.Base `json:"transform"`
Vectors *types.Vector `json:"vectors,omitempty"`
VotingOnly types.Base `json:"voting_only"`
Watcher types.Watcher `json:"watcher"`
}
Response holds the response body struct for the package usage
type Usage ¶
type Usage struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Usage
Retrieves usage information about the installed X-Pack features.
https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html
func (Usage) Do ¶
Do runs the request through the transport, handle the response and returns a usage.Response
func (*Usage) ErrorTrace ¶ added in v8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Usage) FilterPath ¶ added in v8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Usage) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Usage) Human ¶ added in v8.14.0
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 (Usage) IsSuccess ¶
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 ¶
MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout
Source Files