allocation

Documentation

Overview

Provides a snapshot of the number of shards allocated to each data node and their disk space. 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 Allocation
  • func New(tp elastictransport.Interface) *Allocation
  • func (r *Allocation) Bytes(bytes bytes.Bytes) *Allocation
  • func (r Allocation) Do(providedCtx context.Context) (Response, error)
  • func (r *Allocation) ErrorTrace(errortrace bool) *Allocation
  • func (r *Allocation) FilterPath(filterpaths ...string) *Allocation
  • func (r *Allocation) Format(format string) *Allocation
  • func (r *Allocation) H(names ...string) *Allocation
  • func (r *Allocation) Header(key, value string) *Allocation
  • func (r *Allocation) Help(help bool) *Allocation
  • func (r *Allocation) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Allocation) Human(human bool) *Allocation
  • func (r Allocation) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Allocation) Local(local bool) *Allocation
  • func (r *Allocation) MasterTimeout(duration string) *Allocation
  • func (r *Allocation) NodeId(nodeid string) *Allocation
  • func (r Allocation) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Allocation) Pretty(pretty bool) *Allocation
  • func (r *Allocation) S(names ...string) *Allocation
  • func (r *Allocation) V(v bool) *Allocation
• type NewAllocation
  • func NewAllocationFunc(tp elastictransport.Interface) NewAllocation
• 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 Allocation

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

func New

func New(tp elastictransport.Interface) *Allocation

Provides a snapshot of the number of shards allocated to each data node and their disk space. 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-allocation.html

func (*Allocation) Bytes

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

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

func (Allocation) Do

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

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

func (*Allocation) ErrorTrace

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

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

func (*Allocation) FilterPath

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

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

func (*Allocation) Format

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

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

func (*Allocation) H

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

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

func (*Allocation) Header

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

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

func (*Allocation) Help

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

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

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

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

func (*Allocation) Human

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

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

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

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

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

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

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

func (*Allocation) NodeId

func (r *Allocation) NodeId(nodeid string) *Allocation

NodeId Comma-separated list of node identifiers or names used to limit the returned information. API Name: nodeid

func (Allocation) Perform

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

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

func (*Allocation) Pretty

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

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

func (*Allocation) S

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

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

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

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

type NewAllocation

type NewAllocation func() *Allocation

NewAllocation type alias for index.

func NewAllocationFunc

func NewAllocationFunc(tp elastictransport.Interface) NewAllocation

NewAllocationFunc returns a new instance of Allocation 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.AllocationRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response