shards

Documentation

Overview

Provides a detailed view of shard allocation on nodes.

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(ctx context.Context) (Response, error)
  • func (r *Shards) Header(key, value string) *Shards
  • func (r *Shards) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Shards) Index(index string) *Shards
  • func (r Shards) IsSuccess(ctx context.Context) (bool, error)
  • func (r Shards) Perform(ctx context.Context) (*http.Response, error)

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

Provides a detailed view of shard allocation on nodes.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/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(ctx context.Context) (Response, error)

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

func (*Shards) Header

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

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

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

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

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