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(ctx context.Context) (Response, error)
  • func (r *Indices) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Indices
  • func (r *Indices) Header(key, value string) *Indices
  • func (r *Indices) Health(health healthstatus.HealthStatus) *Indices
  • func (r *Indices) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Indices) IncludeUnloadedSegments(includeunloadedsegments bool) *Indices
  • func (r *Indices) Index(index string) *Indices
  • func (r Indices) IsSuccess(ctx context.Context) (bool, error)
  • func (r Indices) Perform(ctx context.Context) (*http.Response, error)
  • func (r *Indices) Pri(pri bool) *Indices
  • func (r *Indices) Time(time timeunit.TimeUnit) *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/{branch}/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(ctx context.Context) (Response, error)

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

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

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

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

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(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 (Indices) Perform

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

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

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

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

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

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