postfeatureupgrade

Documentation

Overview

Begin upgrades for system features

Index

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

Begin upgrades for system features

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

func (PostFeatureUpgrade) Do

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

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

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

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

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

func (PostFeatureUpgrade) IsSuccess

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

func (r PostFeatureUpgrade) Perform(ctx context.Context) (*http.Response, error)

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

type Response

type Response struct {
	Accepted bool                         `json:"accepted"`
	Features []types.PostMigrationFeature `json:"features"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response