fielddata

Documentation

Overview

Returns the amount of heap memory currently used by the field data cache on every data node in the cluster. 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 nodes stats API.

Index

• Variables
• type Fielddata
  • func New(tp elastictransport.Interface) *Fielddata
  • func (r *Fielddata) Bytes(bytes bytes.Bytes) *Fielddata
  • func (r Fielddata) Do(providedCtx context.Context) (Response, error)
  • func (r *Fielddata) ErrorTrace(errortrace bool) *Fielddata
  • func (r *Fielddata) Fields(fields string) *Fielddata
  • func (r *Fielddata) FilterPath(filterpaths ...string) *Fielddata
  • func (r *Fielddata) Format(format string) *Fielddata
  • func (r *Fielddata) H(names ...string) *Fielddata
  • func (r *Fielddata) Header(key, value string) *Fielddata
  • func (r *Fielddata) Help(help bool) *Fielddata
  • func (r *Fielddata) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Fielddata) Human(human bool) *Fielddata
  • func (r Fielddata) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Fielddata) Local(local bool) *Fielddata
  • func (r *Fielddata) MasterTimeout(duration string) *Fielddata
  • func (r Fielddata) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Fielddata) Pretty(pretty bool) *Fielddata
  • func (r *Fielddata) S(names ...string) *Fielddata
  • func (r *Fielddata) V(v bool) *Fielddata
• type NewFielddata
  • func NewFielddataFunc(tp elastictransport.Interface) NewFielddata
• 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 Fielddata

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

func New

func New(tp elastictransport.Interface) *Fielddata

Returns the amount of heap memory currently used by the field data cache on every data node in the cluster. 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 nodes stats API.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-fielddata.html

func (*Fielddata) Bytes

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

Bytes The unit used to display byte values. API name: bytes

func (Fielddata) Do

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

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

func (*Fielddata) ErrorTrace

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

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

func (*Fielddata) Fields

func (r *Fielddata) Fields(fields string) *Fielddata

Fields Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter. API Name: fields

func (*Fielddata) FilterPath

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

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

func (*Fielddata) Format

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

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

func (*Fielddata) H

func (r *Fielddata) H(names ...string) *Fielddata

H List of columns to appear in the response. Supports simple wildcards. API name: h

func (*Fielddata) Header

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

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

func (*Fielddata) Help

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

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 (*Fielddata) HttpRequest

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

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

func (*Fielddata) Human

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

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 (Fielddata) IsSuccess

func (r Fielddata) 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 (*Fielddata) Local

func (r *Fielddata) Local(local bool) *Fielddata

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 (*Fielddata) MasterTimeout

func (r *Fielddata) MasterTimeout(duration string) *Fielddata

MasterTimeout Period to wait for a connection to the master node. API name: master_timeout

func (Fielddata) Perform

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

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

func (*Fielddata) Pretty

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

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

func (*Fielddata) S

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

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 (*Fielddata) V

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

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

type NewFielddata

type NewFielddata func() *Fielddata

NewFielddata type alias for index.

func NewFielddataFunc

func NewFielddataFunc(tp elastictransport.Interface) NewFielddata

NewFielddataFunc returns a new instance of Fielddata 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.FielddataRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response