setupgrademode

Documentation

Overview

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

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

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/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/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

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

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

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

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