shards

Documentation

Overview

Returns information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

Index

• Variables
• type NewShards
  • func NewShardsFunc(tp elastictransport.Interface) NewShards
• type Response
  • func NewResponse() Response
• type Shards
  • func New(tp elastictransport.Interface) *Shards
  • func (r *Shards) Bytes(bytes bytes.Bytes) *Shards
  • func (r Shards) Do(providedCtx context.Context) (Response, error)
  • func (r *Shards) ErrorTrace(errortrace bool) *Shards
  • func (r *Shards) FilterPath(filterpaths ...string) *Shards
  • func (r *Shards) Format(format string) *Shards
  • func (r *Shards) H(names ...string) *Shards
  • func (r *Shards) Header(key, value string) *Shards
  • func (r *Shards) Help(help bool) *Shards
  • func (r *Shards) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Shards) Human(human bool) *Shards
  • func (r *Shards) Index(index string) *Shards
  • func (r Shards) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Shards) Local(local bool) *Shards
  • func (r *Shards) MasterTimeout(duration string) *Shards
  • func (r Shards) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Shards) Pretty(pretty bool) *Shards
  • func (r *Shards) S(names ...string) *Shards
  • func (r *Shards) V(v bool) *Shards

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 NewShards

type NewShards func() *Shards

NewShards type alias for index.

func NewShardsFunc

func NewShardsFunc(tp elastictransport.Interface) NewShards

NewShardsFunc returns a new instance of Shards 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.ShardsRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response

type Shards

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

func New

func New(tp elastictransport.Interface) *Shards

Returns information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

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

func (*Shards) Bytes

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

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

func (Shards) Do

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

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

func (*Shards) ErrorTrace

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

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

func (*Shards) FilterPath

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

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

func (*Shards) Format

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

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

func (*Shards) H

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

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

func (*Shards) Header

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

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

func (*Shards) Help

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

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

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

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

func (*Shards) Human

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

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 (*Shards) Index

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

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

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

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

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

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

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

func (Shards) Perform

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

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

func (*Shards) Pretty

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

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

func (*Shards) S

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

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

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

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