deletevotingconfigexclusions

Documentation

Overview

Clears cluster voting config exclusions.

Index

• Variables
• type DeleteVotingConfigExclusions
  • func New(tp elastictransport.Interface) *DeleteVotingConfigExclusions
  • func (r DeleteVotingConfigExclusions) Do(ctx context.Context) (bool, error)
  • func (r *DeleteVotingConfigExclusions) ErrorTrace(errortrace bool) *DeleteVotingConfigExclusions
  • func (r *DeleteVotingConfigExclusions) FilterPath(filterpaths ...string) *DeleteVotingConfigExclusions
  • func (r *DeleteVotingConfigExclusions) Header(key, value string) *DeleteVotingConfigExclusions
  • func (r *DeleteVotingConfigExclusions) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *DeleteVotingConfigExclusions) Human(human bool) *DeleteVotingConfigExclusions
  • func (r DeleteVotingConfigExclusions) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r DeleteVotingConfigExclusions) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *DeleteVotingConfigExclusions) Pretty(pretty bool) *DeleteVotingConfigExclusions
  • func (r *DeleteVotingConfigExclusions) WaitForRemoval(waitforremoval bool) *DeleteVotingConfigExclusions
• type NewDeleteVotingConfigExclusions
  • func NewDeleteVotingConfigExclusionsFunc(tp elastictransport.Interface) NewDeleteVotingConfigExclusions

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 DeleteVotingConfigExclusions

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

func New

func New(tp elastictransport.Interface) *DeleteVotingConfigExclusions

Clears cluster voting config exclusions.

https://www.elastic.co/guide/en/elasticsearch/reference/current/voting-config-exclusions.html

func (DeleteVotingConfigExclusions) Do

func (r DeleteVotingConfigExclusions) Do(ctx context.Context) (bool, error)

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

func (*DeleteVotingConfigExclusions) ErrorTrace

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

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

func (*DeleteVotingConfigExclusions) FilterPath

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

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

func (*DeleteVotingConfigExclusions) Header

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

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

func (*DeleteVotingConfigExclusions) HttpRequest

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

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

func (*DeleteVotingConfigExclusions) Human

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

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

func (r DeleteVotingConfigExclusions) 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 (DeleteVotingConfigExclusions) Perform

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

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

func (*DeleteVotingConfigExclusions) Pretty

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

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

func (*DeleteVotingConfigExclusions) WaitForRemoval

func (r *DeleteVotingConfigExclusions) WaitForRemoval(waitforremoval bool) *DeleteVotingConfigExclusions

WaitForRemoval Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to false then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster. API name: wait_for_removal

type NewDeleteVotingConfigExclusions

type NewDeleteVotingConfigExclusions func() *DeleteVotingConfigExclusions

NewDeleteVotingConfigExclusions type alias for index.

func NewDeleteVotingConfigExclusionsFunc

func NewDeleteVotingConfigExclusionsFunc(tp elastictransport.Interface) NewDeleteVotingConfigExclusions

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