Documentation
¶
Overview ¶
Start the feature migration. Version upgrades sometimes require changes to how features store configuration information and data in system indices. This API starts the automatic migration process.
Some functionality might be temporarily unavailable during the migration process.
TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.
Index ¶
- Variables
- type NewPostFeatureUpgrade
- type PostFeatureUpgrade
- func (r PostFeatureUpgrade) Do(providedCtx context.Context) (*Response, error)
- func (r *PostFeatureUpgrade) ErrorTrace(errortrace bool) *PostFeatureUpgrade
- func (r *PostFeatureUpgrade) FilterPath(filterpaths ...string) *PostFeatureUpgrade
- func (r *PostFeatureUpgrade) Header(key, value string) *PostFeatureUpgrade
- func (r *PostFeatureUpgrade) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PostFeatureUpgrade) Human(human bool) *PostFeatureUpgrade
- func (r PostFeatureUpgrade) IsSuccess(providedCtx context.Context) (bool, error)
- func (r PostFeatureUpgrade) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PostFeatureUpgrade) Pretty(pretty bool) *PostFeatureUpgrade
- type Response
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 NewPostFeatureUpgrade ¶
type NewPostFeatureUpgrade func() *PostFeatureUpgrade
NewPostFeatureUpgrade type alias for index.
func NewPostFeatureUpgradeFunc ¶
func NewPostFeatureUpgradeFunc(tp elastictransport.Interface) NewPostFeatureUpgrade
NewPostFeatureUpgradeFunc returns a new instance of PostFeatureUpgrade with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PostFeatureUpgrade ¶
type PostFeatureUpgrade struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *PostFeatureUpgrade
Start the feature migration. Version upgrades sometimes require changes to how features store configuration information and data in system indices. This API starts the automatic migration process.
Some functionality might be temporarily unavailable during the migration process.
TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.
func (PostFeatureUpgrade) Do ¶
func (r PostFeatureUpgrade) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a postfeatureupgrade.Response
func (*PostFeatureUpgrade) ErrorTrace ¶
func (r *PostFeatureUpgrade) ErrorTrace(errortrace bool) *PostFeatureUpgrade
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*PostFeatureUpgrade) FilterPath ¶
func (r *PostFeatureUpgrade) FilterPath(filterpaths ...string) *PostFeatureUpgrade
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*PostFeatureUpgrade) Header ¶
func (r *PostFeatureUpgrade) Header(key, value string) *PostFeatureUpgrade
Header set a key, value pair in the PostFeatureUpgrade headers map.
func (*PostFeatureUpgrade) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PostFeatureUpgrade) Human ¶
func (r *PostFeatureUpgrade) Human(human bool) *PostFeatureUpgrade
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 (PostFeatureUpgrade) IsSuccess ¶
func (r PostFeatureUpgrade) 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 (PostFeatureUpgrade) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PostFeatureUpgrade) Pretty ¶
func (r *PostFeatureUpgrade) Pretty(pretty bool) *PostFeatureUpgrade
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
type Response ¶
type Response struct {
Accepted bool `json:"accepted"`
Features []types.PostMigrationFeature `json:"features"`
}
Response holds the response body struct for the package postfeatureupgrade
Source Files