getautoscalingpolicy

Documentation

Overview

Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. 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) Header(key, value string) *GetAutoscalingPolicy
  • func (r *GetAutoscalingPolicy) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r GetAutoscalingPolicy) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetAutoscalingPolicy) Perform(providedCtx context.Context) (*http.Response, error)
• 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

Retrieves an 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 (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) 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) 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.

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/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response