allocationexplain

Documentation

Overview

Provides explanations for shard allocations in the cluster.

Index

• Variables
• type AllocationExplain
  • func New(tp elastictransport.Interface) *AllocationExplain
  • func (r AllocationExplain) Do(ctx context.Context) (*http.Response, error)
  • func (r *AllocationExplain) Header(key, value string) *AllocationExplain
  • func (r *AllocationExplain) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *AllocationExplain) IncludeDiskInfo(b bool) *AllocationExplain
  • func (r *AllocationExplain) IncludeYesDecisions(b bool) *AllocationExplain
  • func (r *AllocationExplain) Raw(raw json.RawMessage) *AllocationExplain
  • func (r *AllocationExplain) Request(req *Request) *AllocationExplain
• type NewAllocationExplain
  • func NewAllocationExplainFunc(tp elastictransport.Interface) NewAllocationExplain
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) CurrentNode(currentnode string) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Index(index types.IndexName) *RequestBuilder
  • func (rb *RequestBuilder) Primary(primary bool) *RequestBuilder
  • func (rb *RequestBuilder) Shard(shard int) *RequestBuilder

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 AllocationExplain

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

func New

func New(tp elastictransport.Interface) *AllocationExplain

Provides explanations for shard allocations in the cluster.

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

func (AllocationExplain) Do

func (r AllocationExplain) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*AllocationExplain) Header

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

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

func (*AllocationExplain) HttpRequest

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

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

func (*AllocationExplain) IncludeDiskInfo

func (r *AllocationExplain) IncludeDiskInfo(b bool) *AllocationExplain

IncludeDiskInfo If true, returns information about disk usage and shard sizes. API name: include_disk_info

func (*AllocationExplain) IncludeYesDecisions

func (r *AllocationExplain) IncludeYesDecisions(b bool) *AllocationExplain

IncludeYesDecisions If true, returns YES decisions in explanation. API name: include_yes_decisions

func (*AllocationExplain) Raw

func (r *AllocationExplain) Raw(raw json.RawMessage) *AllocationExplain

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*AllocationExplain) Request

func (r *AllocationExplain) Request(req *Request) *AllocationExplain

Request allows to set the request property with the appropriate payload.

type NewAllocationExplain

type NewAllocationExplain func() *AllocationExplain

NewAllocationExplain type alias for index.

func NewAllocationExplainFunc

func NewAllocationExplainFunc(tp elastictransport.Interface) NewAllocationExplain

NewAllocationExplainFunc returns a new instance of AllocationExplain with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Request

type Request struct {

	// CurrentNode Specifies the node ID or the name of the node to only explain a shard that is
	// currently located on the specified node.
	CurrentNode *string `json:"current_node,omitempty"`

	// Index Specifies the name of the index that you would like an explanation for.
	Index *types.IndexName `json:"index,omitempty"`

	// Primary If true, returns explanation for the primary shard for the given shard ID.
	Primary *bool `json:"primary,omitempty"`

	// Shard Specifies the ID of the shard that you would like an explanation for.
	Shard *int `json:"shard,omitempty"`
}

Request holds the request body struct for the package allocationexplain

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts#L24-L61

type RequestBuilder

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

RequestBuilder is the builder API for the allocationexplain.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) CurrentNode

func (rb *RequestBuilder) CurrentNode(currentnode string) *RequestBuilder

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Index

func (rb *RequestBuilder) Index(index types.IndexName) *RequestBuilder

func (*RequestBuilder) Primary

func (rb *RequestBuilder) Primary(primary bool) *RequestBuilder

func (*RequestBuilder) Shard

func (rb *RequestBuilder) Shard(shard int) *RequestBuilder