Documentation
¶
Overview ¶
Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.
Index ¶
- Variables
- type NewSetUpgradeMode
- type Response
- type SetUpgradeMode
- func (r SetUpgradeMode) Do(providedCtx context.Context) (*Response, error)
- func (r *SetUpgradeMode) Enabled(enabled bool) *SetUpgradeMode
- func (r *SetUpgradeMode) Header(key, value string) *SetUpgradeMode
- func (r *SetUpgradeMode) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r SetUpgradeMode) IsSuccess(providedCtx context.Context) (bool, error)
- func (r SetUpgradeMode) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *SetUpgradeMode) Timeout(duration string) *SetUpgradeMode
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 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 Response ¶ added in v8.7.0
type Response struct {
// Acknowledged For a successful response, this value is always true. On failure, an
// exception is returned instead.
Acknowledged bool `json:"acknowledged"`
}
Response holds the response body struct for the package setupgrademode
type SetUpgradeMode ¶
type SetUpgradeMode struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *SetUpgradeMode
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 ¶
func (r SetUpgradeMode) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a setupgrademode.Response
func (*SetUpgradeMode) Enabled ¶
func (r *SetUpgradeMode) Enabled(enabled 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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (SetUpgradeMode) IsSuccess ¶
func (r SetUpgradeMode) 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 (SetUpgradeMode) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*SetUpgradeMode) Timeout ¶
func (r *SetUpgradeMode) Timeout(duration string) *SetUpgradeMode
Timeout The time to wait for the request to be completed. API name: timeout
Source Files