getautoscalingcapacity

Documentation

Overview

Get the autoscaling capacity.

NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

This API gets the current autoscaling capacity based on the configured autoscaling policy. It will return information to size the cluster appropriately to the current workload.

The `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy.

The operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.

The response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required. This information is provided for diagnosis only. Do not use this information to make autoscaling decisions.

Index

• Variables
• type GetAutoscalingCapacity
  • func New(tp elastictransport.Interface) *GetAutoscalingCapacity
  • func (r GetAutoscalingCapacity) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetAutoscalingCapacity) ErrorTrace(errortrace bool) *GetAutoscalingCapacity
  • func (r *GetAutoscalingCapacity) FilterPath(filterpaths ...string) *GetAutoscalingCapacity
  • func (r *GetAutoscalingCapacity) Header(key, value string) *GetAutoscalingCapacity
  • func (r *GetAutoscalingCapacity) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetAutoscalingCapacity) Human(human bool) *GetAutoscalingCapacity
  • func (r GetAutoscalingCapacity) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetAutoscalingCapacity) MasterTimeout(duration string) *GetAutoscalingCapacity
  • func (r GetAutoscalingCapacity) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetAutoscalingCapacity) Pretty(pretty bool) *GetAutoscalingCapacity
• 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

Get the autoscaling capacity.

NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

This API gets the current autoscaling capacity based on the configured autoscaling policy. It will return information to size the cluster appropriately to the current workload.

The `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy.

The operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.

The response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required. This information is provided for diagnosis only. Do not use this information to make autoscaling decisions.

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

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

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

func (*GetAutoscalingCapacity) FilterPath

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

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

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

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

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 (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) MasterTimeout

func (r *GetAutoscalingCapacity) MasterTimeout(duration string) *GetAutoscalingCapacity

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

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.

func (*GetAutoscalingCapacity) Pretty

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

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

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/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L25-L29

func NewResponse

func NewResponse() *Response

NewResponse returns a Response