Documentation
¶
Overview ¶
Get segment information.
Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.
Index ¶
- Variables
- type NewSegments
- type Response
- type Segments
- func (r *Segments) Bytes(bytes bytes.Bytes) *Segments
- func (r Segments) Do(providedCtx context.Context) (Response, error)
- func (r *Segments) ErrorTrace(errortrace bool) *Segments
- func (r *Segments) FilterPath(filterpaths ...string) *Segments
- func (r *Segments) Format(format string) *Segments
- func (r *Segments) H(catsegmentscolumns ...catsegmentscolumn.CatSegmentsColumn) *Segments
- func (r *Segments) Header(key, value string) *Segments
- func (r *Segments) Help(help bool) *Segments
- func (r *Segments) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Segments) Human(human bool) *Segments
- func (r *Segments) Index(index string) *Segments
- func (r Segments) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Segments) Local(local bool) *Segments
- func (r *Segments) MasterTimeout(duration string) *Segments
- func (r Segments) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Segments) Pretty(pretty bool) *Segments
- func (r *Segments) S(names ...string) *Segments
- func (r *Segments) Time(time timeunit.TimeUnit) *Segments
- func (r *Segments) V(v bool) *Segments
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 NewSegments ¶
type NewSegments func() *Segments
NewSegments type alias for index.
func NewSegmentsFunc ¶
func NewSegmentsFunc(tp elastictransport.Interface) NewSegments
NewSegmentsFunc returns a new instance of Segments with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶
type Response []types.SegmentsRecord
type Segments ¶
type Segments struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Segments
Get segment information.
Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-segments
func (*Segments) Bytes ¶
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 (Segments) Do ¶
Do runs the request through the transport, handle the response and returns a segments.Response
func (*Segments) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Segments) FilterPath ¶
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Segments) Format ¶
Format Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. API name: format
func (*Segments) H ¶
func (r *Segments) H(catsegmentscolumns ...catsegmentscolumn.CatSegmentsColumn) *Segments
H A comma-separated list of columns names to display. It supports simple wildcards. API name: h
func (*Segments) Help ¶
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 (*Segments) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Segments) Human ¶
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 (*Segments) Index ¶
Index A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. API Name: index
func (Segments) 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 (*Segments) Local ¶
Local If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. API name: local
func (*Segments) MasterTimeout ¶
MasterTimeout Period to wait for a connection to the master node. API name: master_timeout
func (Segments) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Segments) Pretty ¶
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*Segments) S ¶
S A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. API name: s
func (*Segments) Time ¶ added in v9.2.0
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
Source Files