fielddata

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 New(tp elastictransport.Interface) *Fielddata
  • func (r *Fielddata) Bytes(bytes bytes.Bytes) *Fielddata
  • func (r Fielddata) Do(ctx 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(ctx context.Context) (bool, error)
  • func (r Fielddata) Perform(ctx context.Context) (*http.Response, error)
• 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

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) 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(ctx context.Context) (Response, error)

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

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

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

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

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

func (r Fielddata) IsSuccess(ctx 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) Perform

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

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

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