getfeatureupgradestatus

Documentation

Overview

Find out whether system features need to be upgraded or not

Index

• Variables
• type GetFeatureUpgradeStatus
  • func New(tp elastictransport.Interface) *GetFeatureUpgradeStatus
  • func (r GetFeatureUpgradeStatus) Do(ctx context.Context) (*Response, error)
  • func (r *GetFeatureUpgradeStatus) Header(key, value string) *GetFeatureUpgradeStatus
  • func (r *GetFeatureUpgradeStatus) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r GetFeatureUpgradeStatus) IsSuccess(ctx context.Context) (bool, error)
  • func (r GetFeatureUpgradeStatus) Perform(ctx context.Context) (*http.Response, error)
• 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

Find out whether system features need to be upgraded or not

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

func (GetFeatureUpgradeStatus) Do

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

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

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

func (r GetFeatureUpgradeStatus) IsSuccess(ctx 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(ctx context.Context) (*http.Response, error)

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

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/5fea44e006349579bf3561a82e997002e5716117/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts#L23-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response