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 (r *Allocation) Bytes(bytes bytes.Bytes) *Allocation
- func (r Allocation) Do(providedCtx 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(providedCtx context.Context) (bool, error)
- func (r *Allocation) NodeId(nodeid string) *Allocation
- func (r Allocation) Perform(providedCtx context.Context) (*http.Response, error)
- type NewAllocation
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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/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) Header ¶
func (r *Allocation) Header(key, value string) *Allocation
Header set a key, value pair in the Allocation headers map.
func (*Allocation) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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) 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
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 ¶ added in v8.7.0
type Response []types.AllocationRecord
Source Files