allocation

Documentation

Overview

Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.

Index

• Variables
• type Allocation
  • func New(tp elastictransport.Interface) *Allocation
  • func (r *Allocation) Bytes(enum bytes.Bytes) *Allocation
  • func (r Allocation) Do(ctx context.Context) (Response, error)
  • func (r *Allocation) Header(key, value string) *Allocation
  • func (r *Allocation) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Allocation) IsSuccess(ctx context.Context) (bool, error)
  • func (r *Allocation) NodeId(v string) *Allocation
  • func (r Allocation) Perform(ctx context.Context) (*http.Response, error)
• 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 how many shards are allocated to each data node and how much disk space they are using.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-allocation.html

func (*Allocation) Bytes

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

Bytes The unit in which to display byte values API name: bytes

func (Allocation) Do

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

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

func (*Allocation) Header

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

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

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

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

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

NodeId A comma-separated list of node IDs or names to limit the returned information API Name: nodeid

func (Allocation) Perform

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

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

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