upgradetransforms

Documentation

Overview

Upgrades all transforms.

Index

• Variables
• type NewUpgradeTransforms
  • func NewUpgradeTransformsFunc(tp elastictransport.Interface) NewUpgradeTransforms
• type Response
  • func NewResponse() *Response
• type UpgradeTransforms
  • func New(tp elastictransport.Interface) *UpgradeTransforms
  • func (r UpgradeTransforms) Do(ctx context.Context) (*Response, error)
  • func (r *UpgradeTransforms) DryRun(b bool) *UpgradeTransforms
  • func (r *UpgradeTransforms) Header(key, value string) *UpgradeTransforms
  • func (r *UpgradeTransforms) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r UpgradeTransforms) IsSuccess(ctx context.Context) (bool, error)
  • func (r UpgradeTransforms) Perform(ctx context.Context) (*http.Response, error)
  • func (r *UpgradeTransforms) Timeout(v string) *UpgradeTransforms

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 NewUpgradeTransforms

type NewUpgradeTransforms func() *UpgradeTransforms

NewUpgradeTransforms type alias for index.

func NewUpgradeTransformsFunc

func NewUpgradeTransformsFunc(tp elastictransport.Interface) NewUpgradeTransforms

NewUpgradeTransformsFunc returns a new instance of UpgradeTransforms 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 {

	// NeedsUpdate The number of transforms that need to be upgraded.
	NeedsUpdate int `json:"needs_update"`
	// NoAction The number of transforms that don’t require upgrading.
	NoAction int `json:"no_action"`
	// Updated The number of transforms that have been upgraded.
	Updated int `json:"updated"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type UpgradeTransforms

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

func New

func New(tp elastictransport.Interface) *UpgradeTransforms

Upgrades all transforms.

https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html

func (UpgradeTransforms) Do

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

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

func (*UpgradeTransforms) DryRun

func (r *UpgradeTransforms) DryRun(b bool) *UpgradeTransforms

DryRun When true, the request checks for updates but does not run them. API name: dry_run

func (*UpgradeTransforms) Header

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

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

func (*UpgradeTransforms) HttpRequest

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

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

func (UpgradeTransforms) IsSuccess

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

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

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

func (*UpgradeTransforms) Timeout

func (r *UpgradeTransforms) Timeout(v string) *UpgradeTransforms

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout