diskusage

Documentation

Overview

Analyze the index disk usage. Analyze the disk usage of each field of an index or data stream. This API might not support indices created in previous Elasticsearch versions. The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.

Index

• Variables
• type DiskUsage
  • func New(tp elastictransport.Interface) *DiskUsage
  • func (r *DiskUsage) AllowNoIndices(allownoindices bool) *DiskUsage
  • func (r DiskUsage) Do(providedCtx context.Context) (Response, error)
  • func (r *DiskUsage) ErrorTrace(errortrace bool) *DiskUsage
  • func (r *DiskUsage) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *DiskUsage
  • func (r *DiskUsage) FilterPath(filterpaths ...string) *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) Human(human bool) *DiskUsage
  • 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) Pretty(pretty bool) *DiskUsage
  • func (r *DiskUsage) RunExpensiveTasks(runexpensivetasks bool) *DiskUsage
• type NewDiskUsage
  • func NewDiskUsageFunc(tp elastictransport.Interface) NewDiskUsage
• type Response
  • func NewResponse() *Response

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.

Types

type DiskUsage

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

func New

func New(tp elastictransport.Interface) *DiskUsage

Analyze the index disk usage. Analyze the disk usage of each field of an index or data stream. This API might not support indices created in previous Elasticsearch versions. The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.

https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-disk-usage.html

func (*DiskUsage) AllowNoIndices

func (r *DiskUsage) AllowNoIndices(allownoindices bool) *DiskUsage

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

func (r DiskUsage) Do(providedCtx context.Context) (Response, error)

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

func (*DiskUsage) ErrorTrace

func (r *DiskUsage) ErrorTrace(errortrace bool) *DiskUsage

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

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) FilterPath

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

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

func (*DiskUsage) Flush

func (r *DiskUsage) Flush(flush bool) *DiskUsage

Flush If `true`, the API performs a flush before analysis. If `false`, the response may not include uncommitted data. API name: flush

func (*DiskUsage) Header

func (r *DiskUsage) Header(key, value string) *DiskUsage

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

func (*DiskUsage) HttpRequest

func (r *DiskUsage) HttpRequest(ctx context.Context) (*http.Request, error)

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

func (*DiskUsage) Human

func (r *DiskUsage) Human(human bool) *DiskUsage

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 (*DiskUsage) IgnoreUnavailable

func (r *DiskUsage) IgnoreUnavailable(ignoreunavailable bool) *DiskUsage

IgnoreUnavailable If `true`, missing or closed indices are not included in the response. API name: ignore_unavailable

func (DiskUsage) IsSuccess

func (r DiskUsage) 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 (DiskUsage) Perform

func (r DiskUsage) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*DiskUsage) Pretty

func (r *DiskUsage) Pretty(pretty bool) *DiskUsage

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

func (*DiskUsage) RunExpensiveTasks

func (r *DiskUsage) RunExpensiveTasks(runexpensivetasks bool) *DiskUsage

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

type NewDiskUsage func(index string) *DiskUsage

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

type Response = json.RawMessage

func NewResponse

func NewResponse() *Response