getautoscalingcapacity

Documentation

Overview

Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetAutoscalingCapacity

Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html

func (GetAutoscalingCapacity) Do

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

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

func (*GetAutoscalingCapacity) Header

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

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

func (*GetAutoscalingCapacity) HttpRequest

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

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

func (GetAutoscalingCapacity) IsSuccess

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

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

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

type NewGetAutoscalingCapacity

type NewGetAutoscalingCapacity func() *GetAutoscalingCapacity

NewGetAutoscalingCapacity type alias for index.

func NewGetAutoscalingCapacityFunc

func NewGetAutoscalingCapacityFunc(tp elastictransport.Interface) NewGetAutoscalingCapacity

NewGetAutoscalingCapacityFunc returns a new instance of GetAutoscalingCapacity 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 {
	Policies map[string]types.AutoscalingDeciders `json:"policies"`
}

Response holds the response body struct for the package getautoscalingcapacity

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L25-L29

func NewResponse

func NewResponse() *Response

NewResponse returns a Response