Documentation
¶
Overview ¶
Updates the cluster voting config exclusions by node ids or node names.
Index ¶
- Variables
- type NewPostVotingConfigExclusions
- type PostVotingConfigExclusions
- func (r PostVotingConfigExclusions) Do(ctx context.Context) (bool, error)
- func (r *PostVotingConfigExclusions) Header(key, value string) *PostVotingConfigExclusions
- func (r *PostVotingConfigExclusions) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r PostVotingConfigExclusions) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *PostVotingConfigExclusions) NodeIds(ids ...string) *PostVotingConfigExclusions
- func (r *PostVotingConfigExclusions) NodeNames(names ...string) *PostVotingConfigExclusions
- func (r PostVotingConfigExclusions) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PostVotingConfigExclusions) Timeout(duration string) *PostVotingConfigExclusions
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 NewPostVotingConfigExclusions ¶
type NewPostVotingConfigExclusions func() *PostVotingConfigExclusions
NewPostVotingConfigExclusions type alias for index.
func NewPostVotingConfigExclusionsFunc ¶
func NewPostVotingConfigExclusionsFunc(tp elastictransport.Interface) NewPostVotingConfigExclusions
NewPostVotingConfigExclusionsFunc returns a new instance of PostVotingConfigExclusions with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PostVotingConfigExclusions ¶
type PostVotingConfigExclusions struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *PostVotingConfigExclusions
Updates the cluster voting config exclusions by node ids or node names.
https://www.elastic.co/guide/en/elasticsearch/reference/current/voting-config-exclusions.html
func (PostVotingConfigExclusions) Do ¶
func (r PostVotingConfigExclusions) Do(ctx context.Context) (bool, error)
Do runs the request through the transport, handle the response and returns a postvotingconfigexclusions.Response
func (*PostVotingConfigExclusions) Header ¶
func (r *PostVotingConfigExclusions) Header(key, value string) *PostVotingConfigExclusions
Header set a key, value pair in the PostVotingConfigExclusions headers map.
func (*PostVotingConfigExclusions) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (PostVotingConfigExclusions) IsSuccess ¶
func (r PostVotingConfigExclusions) 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 (*PostVotingConfigExclusions) NodeIds ¶
func (r *PostVotingConfigExclusions) NodeIds(ids ...string) *PostVotingConfigExclusions
NodeIds A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify node_names. API name: node_ids
func (*PostVotingConfigExclusions) NodeNames ¶
func (r *PostVotingConfigExclusions) NodeNames(names ...string) *PostVotingConfigExclusions
NodeNames A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify node_ids. API name: node_names
func (PostVotingConfigExclusions) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PostVotingConfigExclusions) Timeout ¶
func (r *PostVotingConfigExclusions) Timeout(duration string) *PostVotingConfigExclusions
Timeout When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error. API name: timeout
Source Files