Documentation
¶
Overview ¶
Allows to manually change the allocation of individual shards in the cluster.
Index ¶
- Variables
- type NewReroute
- type Request
- type 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) Explain(explain bool) *Reroute
- func (r *Reroute) Header(key, value string) *Reroute
- func (r *Reroute) HttpRequest(ctx context.Context) (*http.Request, error)
- 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) 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
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 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
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 ¶ added in v8.9.0
Commands Defines the commands to perform. API name: commands
func (Reroute) Do ¶
Do runs the request through the transport, handle the response and returns a reroute.Response
func (*Reroute) DryRun ¶
DryRun If true, then the request simulates the operation only and returns the resulting state. API name: dry_run
func (*Reroute) Explain ¶
Explain If true, then the response contains an explanation of why the commands can or cannot be executed. API name: explain
func (*Reroute) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Reroute) MasterTimeout ¶
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 ¶
Metric Limits the information returned to the specified metrics. API name: metric
func (Reroute) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Reroute) Raw ¶
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) RetryFailed ¶
RetryFailed If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. API name: retry_failed
type Response ¶ added in v8.7.0
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
Source Files