Documentation
¶
Overview ¶
Analyzes the disk usage of each field of an index or data stream
Index ¶
- Variables
- type DiskUsage
- func (r *DiskUsage) AllowNoIndices(allownoindices bool) *DiskUsage
- func (r DiskUsage) Do(providedCtx context.Context) (Response, error)
- func (r *DiskUsage) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *DiskUsage
- func (r *DiskUsage) Flush(flush bool) *DiskUsage
- func (r *DiskUsage) Header(key, value string) *DiskUsage
- func (r *DiskUsage) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *DiskUsage) IgnoreUnavailable(ignoreunavailable bool) *DiskUsage
- func (r DiskUsage) IsSuccess(providedCtx context.Context) (bool, error)
- func (r DiskUsage) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DiskUsage) RunExpensiveTasks(runexpensivetasks bool) *DiskUsage
- type NewDiskUsage
- 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 DiskUsage ¶
type DiskUsage struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DiskUsage
Analyzes the disk usage of each field of an index or data stream
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-disk-usage.html
func (*DiskUsage) AllowNoIndices ¶
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 (DiskUsage) Do ¶
Do runs the request through the transport, handle the response and returns a diskusage.Response
func (*DiskUsage) ExpandWildcards ¶
func (r *DiskUsage) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *DiskUsage
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 (*DiskUsage) Flush ¶
Flush If `true`, the API performs a flush before analysis. If `false`, the response may not include uncommitted data. API name: flush
func (*DiskUsage) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*DiskUsage) IgnoreUnavailable ¶
IgnoreUnavailable If `true`, missing or closed indices are not included in the response. API name: ignore_unavailable
func (DiskUsage) 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 (DiskUsage) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DiskUsage) RunExpensiveTasks ¶
RunExpensiveTasks Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to `true`. API name: run_expensive_tasks
type NewDiskUsage ¶
NewDiskUsage type alias for index.
func NewDiskUsageFunc ¶
func NewDiskUsageFunc(tp elastictransport.Interface) NewDiskUsage
NewDiskUsageFunc returns a new instance of DiskUsage 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 = json.RawMessage
func NewResponse ¶ added in v8.7.1
func NewResponse() *Response
Source Files