Documentation
¶
Overview ¶
Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
Index ¶
- Variables
- type Fielddata
- func (r *Fielddata) Bytes(bytes bytes.Bytes) *Fielddata
- func (r Fielddata) Do(providedCtx context.Context) (Response, error)
- func (r *Fielddata) Fields(fields string) *Fielddata
- func (r *Fielddata) Header(key, value string) *Fielddata
- func (r *Fielddata) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r Fielddata) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Fielddata) Perform(providedCtx context.Context) (*http.Response, error)
- type NewFielddata
- 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 Fielddata ¶
type Fielddata struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Fielddata
Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-fielddata.html
func (Fielddata) Do ¶
Do runs the request through the transport, handle the response and returns a fielddata.Response
func (*Fielddata) Fields ¶
Fields Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter. API Name: fields
func (*Fielddata) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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 ¶ added in v8.7.0
type Response []types.FielddataRecord
Source Files