indices

Documentation

Overview

Returns information about indices: number of primaries and replicas, document counts, disk size, ...

Index

• Variables
• type Indices
  • func New(tp elastictransport.Interface) *Indices
  • func (r *Indices) Bytes(bytes bytes.Bytes) *Indices
  • func (r Indices) Do(providedCtx context.Context) (Response, error)
  • func (r *Indices) ErrorTrace(errortrace bool) *Indices
  • func (r *Indices) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Indices
  • func (r *Indices) FilterPath(filterpaths ...string) *Indices
  • func (r *Indices) Format(format string) *Indices
  • func (r *Indices) H(names ...string) *Indices
  • func (r *Indices) Header(key, value string) *Indices
  • func (r *Indices) Health(health healthstatus.HealthStatus) *Indices
  • func (r *Indices) Help(help bool) *Indices
  • func (r *Indices) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Indices) Human(human bool) *Indices
  • func (r *Indices) IncludeUnloadedSegments(includeunloadedsegments bool) *Indices
  • func (r *Indices) Index(index string) *Indices
  • func (r Indices) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Indices) Local(local bool) *Indices
  • func (r *Indices) MasterTimeout(duration string) *Indices
  • func (r Indices) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Indices) Pretty(pretty bool) *Indices
  • func (r *Indices) Pri(pri bool) *Indices
  • func (r *Indices) S(names ...string) *Indices
  • func (r *Indices) Time(time timeunit.TimeUnit) *Indices
  • func (r *Indices) V(v bool) *Indices
• type NewIndices
  • func NewIndicesFunc(tp elastictransport.Interface) NewIndices
• 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 Indices

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

func New

func New(tp elastictransport.Interface) *Indices

Returns information about indices: number of primaries and replicas, document counts, disk size, ...

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

func (*Indices) Bytes

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

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

func (Indices) Do

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

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

func (*Indices) ErrorTrace

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

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

func (*Indices) ExpandWildcards

func (r *Indices) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Indices

ExpandWildcards The type of index that wildcard patterns can match. API name: expand_wildcards

func (*Indices) FilterPath

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

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

func (*Indices) Format

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

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

func (*Indices) H

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

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

func (*Indices) Header

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

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

func (*Indices) Health

func (r *Indices) Health(health healthstatus.HealthStatus) *Indices

Health The health status used to limit returned indices. By default, the response includes indices of any health status. API name: health

func (*Indices) Help

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

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

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

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

func (*Indices) Human

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

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 (*Indices) IncludeUnloadedSegments

func (r *Indices) IncludeUnloadedSegments(includeunloadedsegments bool) *Indices

IncludeUnloadedSegments If true, the response includes information from segments that are not loaded into memory. API name: include_unloaded_segments

func (*Indices) Index

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

Index 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 (Indices) IsSuccess

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

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

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

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

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

func (Indices) Perform

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

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

func (*Indices) Pretty

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

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

func (*Indices) Pri

func (r *Indices) Pri(pri bool) *Indices

Pri If true, the response only includes information from primary shards. API name: pri

func (*Indices) S

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

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 (*Indices) Time

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

Time The unit used to display time values. API name: time

func (*Indices) V

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

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

type NewIndices

type NewIndices func() *Indices

NewIndices type alias for index.

func NewIndicesFunc

func NewIndicesFunc(tp elastictransport.Interface) NewIndices

NewIndicesFunc returns a new instance of Indices 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.IndicesRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response