getautoscalingpolicy

Documentation

Overview

Get an autoscaling policy.

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

Index

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

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

func New

func New(tp elastictransport.Interface) *GetAutoscalingPolicy

Get an autoscaling policy.

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

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

func (GetAutoscalingPolicy) Do

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

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

func (*GetAutoscalingPolicy) ErrorTrace

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

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

func (*GetAutoscalingPolicy) FilterPath

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

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

func (*GetAutoscalingPolicy) Header

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

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

func (*GetAutoscalingPolicy) HttpRequest

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

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

func (*GetAutoscalingPolicy) Human

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

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

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

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

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

func (*GetAutoscalingPolicy) Pretty

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

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

type NewGetAutoscalingPolicy

type NewGetAutoscalingPolicy func(name string) *GetAutoscalingPolicy

NewGetAutoscalingPolicy type alias for index.

func NewGetAutoscalingPolicyFunc

func NewGetAutoscalingPolicyFunc(tp elastictransport.Interface) NewGetAutoscalingPolicy

NewGetAutoscalingPolicyFunc returns a new instance of GetAutoscalingPolicy 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 {

	// Deciders Decider settings.
	Deciders map[string]json.RawMessage `json:"deciders"`
	Roles    []string                   `json:"roles"`
}

Response holds the response body struct for the package getautoscalingpolicy

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response