Documentation
¶
Overview ¶
Returns the field usage stats for each field of an index
Index ¶
- Variables
- type FieldUsageStats
- func (r *FieldUsageStats) AllowNoIndices(allownoindices bool) *FieldUsageStats
- func (r FieldUsageStats) Do(providedCtx context.Context) (*Response, error)
- func (r *FieldUsageStats) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *FieldUsageStats
- func (r *FieldUsageStats) Fields(fields ...string) *FieldUsageStats
- func (r *FieldUsageStats) Header(key, value string) *FieldUsageStats
- func (r *FieldUsageStats) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *FieldUsageStats) IgnoreUnavailable(ignoreunavailable bool) *FieldUsageStats
- func (r FieldUsageStats) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *FieldUsageStats) MasterTimeout(duration string) *FieldUsageStats
- func (r FieldUsageStats) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *FieldUsageStats) Timeout(duration string) *FieldUsageStats
- func (r *FieldUsageStats) WaitForActiveShards(waitforactiveshards string) *FieldUsageStats
- type NewFieldUsageStats
- 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 FieldUsageStats ¶
type FieldUsageStats struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *FieldUsageStats
Returns the field usage stats for each field of an index
https://www.elastic.co/guide/en/elasticsearch/reference/current/field-usage-stats.html
func (*FieldUsageStats) AllowNoIndices ¶
func (r *FieldUsageStats) AllowNoIndices(allownoindices bool) *FieldUsageStats
AllowNoIndices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. API name: allow_no_indices
func (FieldUsageStats) Do ¶
func (r FieldUsageStats) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a fieldusagestats.Response
func (*FieldUsageStats) ExpandWildcards ¶
func (r *FieldUsageStats) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *FieldUsageStats
ExpandWildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. API name: expand_wildcards
func (*FieldUsageStats) Fields ¶
func (r *FieldUsageStats) Fields(fields ...string) *FieldUsageStats
Fields Comma-separated list or wildcard expressions of fields to include in the statistics. API name: fields
func (*FieldUsageStats) Header ¶
func (r *FieldUsageStats) Header(key, value string) *FieldUsageStats
Header set a key, value pair in the FieldUsageStats headers map.
func (*FieldUsageStats) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*FieldUsageStats) IgnoreUnavailable ¶
func (r *FieldUsageStats) IgnoreUnavailable(ignoreunavailable bool) *FieldUsageStats
IgnoreUnavailable If `true`, missing or closed indices are not included in the response. API name: ignore_unavailable
func (FieldUsageStats) IsSuccess ¶
func (r FieldUsageStats) 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 (*FieldUsageStats) MasterTimeout ¶
func (r *FieldUsageStats) MasterTimeout(duration string) *FieldUsageStats
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
func (FieldUsageStats) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*FieldUsageStats) Timeout ¶
func (r *FieldUsageStats) Timeout(duration string) *FieldUsageStats
Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout
func (*FieldUsageStats) WaitForActiveShards ¶
func (r *FieldUsageStats) WaitForActiveShards(waitforactiveshards string) *FieldUsageStats
WaitForActiveShards The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). API name: wait_for_active_shards
type NewFieldUsageStats ¶
type NewFieldUsageStats func(index string) *FieldUsageStats
NewFieldUsageStats type alias for index.
func NewFieldUsageStatsFunc ¶
func NewFieldUsageStatsFunc(tp elastictransport.Interface) NewFieldUsageStats
NewFieldUsageStatsFunc returns a new instance of FieldUsageStats 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 {
FieldsUsageBody map[string]types.UsageStatsIndex `json:"-"`
Shards_ types.ShardStatistics `json:"_shards"`
}
Response holds the response body struct for the package fieldusagestats
Source Files