count

func (*Count) Bytes ¶ added in v9.2.0

func (r *Count) Bytes(bytes bytes.Bytes) *Count

Bytes Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down. API name: bytes

func (Count) Do ¶

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

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

func (*Count) ErrorTrace ¶

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

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

func (*Count) FilterPath ¶

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

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

func (*Count) Format ¶

func (r *Count) Format(format string) *Count

Format Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. API name: format

func (*Count) H ¶

func (r *Count) H(catcountcolumns ...catcountcolumn.CatCountColumn) *Count

H A comma-separated list of columns names to display. It supports simple wildcards. API name: h

func (*Count) Header ¶

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

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

func (*Count) Help ¶

func (r *Count) Help(help bool) *Count

Help When set to `true` will output available columns. This option can't be combined with any other query string option. API name: help

func (*Count) HttpRequest ¶

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

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

func (*Count) Human ¶

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

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 (*Count) Index ¶

func (r *Count) Index(index string) *Count

Index A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. API Name: index

func (Count) IsSuccess ¶

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

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

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

func (*Count) Pretty ¶

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

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

func (*Count) ProjectRouting ¶ added in v9.2.0

func (r *Count) ProjectRouting(projectrouting string) *Count

ProjectRouting Specifies a subset of projects to target for the search using project metadata tags in a subset of Lucene query syntax. Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded). Examples:

_alias:my-project
_alias:_origin
_alias:*pr*

Supported in serverless only. API name: project_routing

func (*Count) S ¶

func (r *Count) S(names ...string) *Count

S List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. API name: s

func (*Count) Time ¶ added in v9.2.0

func (r *Count) Time(time timeunit.TimeUnit) *Count

Time Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down. API name: time

func (*Count) V ¶

func (r *Count) V(v bool) *Count

V When set to `true` will enable verbose output. API name: v