setupgrademode

Documentation

Overview

Set upgrade_mode for ML indices. Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. When upgrading your cluster, in some circumstances you must restart your nodes and reindex your machine learning indices. In those circumstances, there must be no machine learning jobs running. You can close the machine learning jobs, do the upgrade, then open all the jobs again. Alternatively, you can use this API to temporarily halt tasks associated with the jobs and datafeeds and prevent new jobs from opening. You can also use this API during upgrades that do not require you to reindex your machine learning indices, though stopping jobs is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get machine learning info API.

Index

• Variables
• type NewSetUpgradeMode
  • func NewSetUpgradeModeFunc(tp elastictransport.Interface) NewSetUpgradeMode
• type Response
  • func NewResponse() *Response
• type SetUpgradeMode
  • func New(tp elastictransport.Interface) *SetUpgradeMode
  • func (r SetUpgradeMode) Do(providedCtx context.Context) (*Response, error)
  • func (r *SetUpgradeMode) Enabled(enabled bool) *SetUpgradeMode
  • func (r *SetUpgradeMode) ErrorTrace(errortrace bool) *SetUpgradeMode
  • func (r *SetUpgradeMode) FilterPath(filterpaths ...string) *SetUpgradeMode
  • func (r *SetUpgradeMode) Header(key, value string) *SetUpgradeMode
  • func (r *SetUpgradeMode) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *SetUpgradeMode) Human(human bool) *SetUpgradeMode
  • func (r SetUpgradeMode) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r SetUpgradeMode) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *SetUpgradeMode) Pretty(pretty bool) *SetUpgradeMode
  • func (r *SetUpgradeMode) Timeout(duration string) *SetUpgradeMode

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 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

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

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/set_upgrade_mode/MlSetUpgradeModeResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type SetUpgradeMode

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

func New

func New(tp elastictransport.Interface) *SetUpgradeMode

Set upgrade_mode for ML indices. Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. When upgrading your cluster, in some circumstances you must restart your nodes and reindex your machine learning indices. In those circumstances, there must be no machine learning jobs running. You can close the machine learning jobs, do the upgrade, then open all the jobs again. Alternatively, you can use this API to temporarily halt tasks associated with the jobs and datafeeds and prevent new jobs from opening. You can also use this API during upgrades that do not require you to reindex your machine learning indices, though stopping jobs is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get machine learning info API.

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) ErrorTrace

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

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

func (*SetUpgradeMode) FilterPath

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

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

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) Human

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

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 (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

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

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

func (*SetUpgradeMode) Pretty

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

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

func (*SetUpgradeMode) Timeout

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

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