reroute

Documentation

Overview

Allows to manually change the allocation of individual shards in the cluster.

Index

• Variables
• type NewReroute
  • func NewRerouteFunc(tp elastictransport.Interface) NewReroute
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Reroute
  • func New(tp elastictransport.Interface) *Reroute
  • func (r *Reroute) Commands(commands ...types.Command) *Reroute
  • func (r Reroute) Do(providedCtx context.Context) (*Response, error)
  • func (r *Reroute) DryRun(dryrun bool) *Reroute
  • func (r *Reroute) ErrorTrace(errortrace bool) *Reroute
  • func (r *Reroute) Explain(explain bool) *Reroute
  • func (r *Reroute) FilterPath(filterpaths ...string) *Reroute
  • func (r *Reroute) Header(key, value string) *Reroute
  • func (r *Reroute) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Reroute) Human(human bool) *Reroute
  • func (r *Reroute) MasterTimeout(duration string) *Reroute
  • func (r *Reroute) Metric(metrics ...string) *Reroute
  • func (r Reroute) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Reroute) Pretty(pretty bool) *Reroute
  • func (r *Reroute) Raw(raw io.Reader) *Reroute
  • func (r *Reroute) Request(req *Request) *Reroute
  • func (r *Reroute) RetryFailed(retryfailed bool) *Reroute
  • func (r *Reroute) Timeout(duration string) *Reroute
• 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 NewReroute

type NewReroute func() *Reroute

NewReroute type alias for index.

func NewRerouteFunc

func NewRerouteFunc(tp elastictransport.Interface) NewReroute

NewRerouteFunc returns a new instance of Reroute 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 {

	// Commands Defines the commands to perform.
	Commands []types.Command `json:"commands,omitempty"`
}

Request holds the request body struct for the package reroute

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/cluster/reroute/ClusterRerouteRequest.ts#L25-L70

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Reroute

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

func New

func New(tp elastictransport.Interface) *Reroute

Allows to manually change the allocation of individual shards in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html

func (*Reroute) Commands

func (r *Reroute) Commands(commands ...types.Command) *Reroute

Commands Defines the commands to perform. API name: commands

func (Reroute) Do

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

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

func (*Reroute) DryRun

func (r *Reroute) DryRun(dryrun bool) *Reroute

DryRun If true, then the request simulates the operation only and returns the resulting state. API name: dry_run

func (*Reroute) ErrorTrace

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

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

func (*Reroute) Explain

func (r *Reroute) Explain(explain bool) *Reroute

Explain If true, then the response contains an explanation of why the commands can or cannot be executed. API name: explain

func (*Reroute) FilterPath

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

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

func (*Reroute) Header

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

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

func (*Reroute) HttpRequest

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

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

func (*Reroute) Human

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

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

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

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (*Reroute) Metric

func (r *Reroute) Metric(metrics ...string) *Reroute

Metric Limits the information returned to the specified metrics. API name: metric

func (Reroute) Perform

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

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

func (*Reroute) Pretty

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

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

func (*Reroute) Raw

func (r *Reroute) Raw(raw io.Reader) *Reroute

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

func (*Reroute) Request

func (r *Reroute) Request(req *Request) *Reroute

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

func (*Reroute) RetryFailed

func (r *Reroute) RetryFailed(retryfailed bool) *Reroute

RetryFailed If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. API name: retry_failed

func (*Reroute) Timeout

func (r *Reroute) Timeout(duration string) *Reroute

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

type Response

type Response struct {
	Acknowledged bool                       `json:"acknowledged"`
	Explanations []types.RerouteExplanation `json:"explanations,omitempty"`
	// State There aren't any guarantees on the output/structure of the raw cluster state.
	// Here you will find the internal representation of the cluster, which can
	// differ from the external representation.
	State json.RawMessage `json:"state,omitempty"`
}

Response holds the response body struct for the package reroute

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/cluster/reroute/ClusterRerouteResponse.ts#L23-L34

func NewResponse

func NewResponse() *Response

NewResponse returns a Response