setupgrademode

package
v8.4.0-alpha.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 18, 2022 License: Apache-2.0 Imports: 11 Imported by: 4

Documentation

Overview

Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.

Index

Constants

This section is empty.

Variables

View Source
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 NewSetUpgradeMode

type NewSetUpgradeMode func() *SetUpgradeMode

NewSetUpgradeMode type alias for index.

func NewSetUpgradeModeFunc

func NewSetUpgradeModeFunc(tp elastictransport.Interface) NewSetUpgradeMode

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

type SetUpgradeMode

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

func New

Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html

func (SetUpgradeMode) Do

Do runs the http.Request through the provided transport.

func (*SetUpgradeMode) Enabled

func (r *SetUpgradeMode) Enabled(b bool) *SetUpgradeMode

Enabled When `true`, it enables `upgrade_mode` which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from starting. API name: enabled

func (*SetUpgradeMode) Header

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

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

func (*SetUpgradeMode) HttpRequest

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

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

func (SetUpgradeMode) IsSuccess

func (r SetUpgradeMode) IsSuccess(ctx 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 (*SetUpgradeMode) Timeout

func (r *SetUpgradeMode) Timeout(value string) *SetUpgradeMode

Timeout The time to wait for the request to be completed. API name: timeout

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL