getfeatureupgradestatus

Documentation

Overview

Get feature migration information. Version upgrades sometimes require changes to how features store configuration information and data in system indices. Check which features need to be migrated and the status of any migrations that are in progress.

TIP: This API is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant.

Index

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

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 GetFeatureUpgradeStatus

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

func New

func New(tp elastictransport.Interface) *GetFeatureUpgradeStatus

Get feature migration information. Version upgrades sometimes require changes to how features store configuration information and data in system indices. Check which features need to be migrated and the status of any migrations that are in progress.

TIP: This API is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant.

https://www.elastic.co/guide/en/elasticsearch/reference/current/feature-migration-api.html

func (GetFeatureUpgradeStatus) Do

func (r GetFeatureUpgradeStatus) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a getfeatureupgradestatus.Response

func (*GetFeatureUpgradeStatus) ErrorTrace

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

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

func (*GetFeatureUpgradeStatus) FilterPath

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

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

func (*GetFeatureUpgradeStatus) Header

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

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

func (*GetFeatureUpgradeStatus) HttpRequest

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

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

func (*GetFeatureUpgradeStatus) Human

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

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 (GetFeatureUpgradeStatus) IsSuccess

func (r GetFeatureUpgradeStatus) 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 (GetFeatureUpgradeStatus) Perform

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

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

func (*GetFeatureUpgradeStatus) Pretty

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

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

type NewGetFeatureUpgradeStatus

type NewGetFeatureUpgradeStatus func() *GetFeatureUpgradeStatus

NewGetFeatureUpgradeStatus type alias for index.

func NewGetFeatureUpgradeStatusFunc

func NewGetFeatureUpgradeStatusFunc(tp elastictransport.Interface) NewGetFeatureUpgradeStatus

NewGetFeatureUpgradeStatusFunc returns a new instance of GetFeatureUpgradeStatus 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 {
	Features        []types.GetMigrationFeature     `json:"features"`
	MigrationStatus migrationstatus.MigrationStatus `json:"migration_status"`
}

Response holds the response body struct for the package getfeatureupgradestatus

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts#L23-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response