putautoscalingpolicy

Documentation

Overview

Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

Index

• Variables
• type NewPutAutoscalingPolicy
  • func NewPutAutoscalingPolicyFunc(tp elastictransport.Interface) NewPutAutoscalingPolicy
• type PutAutoscalingPolicy
  • func New(tp elastictransport.Interface) *PutAutoscalingPolicy
  • func (r *PutAutoscalingPolicy) Deciders(deciders map[string]json.RawMessage) *PutAutoscalingPolicy
  • func (r PutAutoscalingPolicy) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutAutoscalingPolicy) Header(key, value string) *PutAutoscalingPolicy
  • func (r *PutAutoscalingPolicy) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r PutAutoscalingPolicy) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutAutoscalingPolicy) Raw(raw io.Reader) *PutAutoscalingPolicy
  • func (r *PutAutoscalingPolicy) Request(req *Request) *PutAutoscalingPolicy
  • func (r *PutAutoscalingPolicy) Roles(roles ...string) *PutAutoscalingPolicy
• type Request
• 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 NewPutAutoscalingPolicy

type NewPutAutoscalingPolicy func(name string) *PutAutoscalingPolicy

NewPutAutoscalingPolicy type alias for index.

func NewPutAutoscalingPolicyFunc

func NewPutAutoscalingPolicyFunc(tp elastictransport.Interface) NewPutAutoscalingPolicy

NewPutAutoscalingPolicyFunc returns a new instance of PutAutoscalingPolicy with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type PutAutoscalingPolicy

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

func New

func New(tp elastictransport.Interface) *PutAutoscalingPolicy

Creates a new 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-put-autoscaling-policy.html

func (*PutAutoscalingPolicy) Deciders

func (r *PutAutoscalingPolicy) Deciders(deciders map[string]json.RawMessage) *PutAutoscalingPolicy

Deciders Decider settings API name: deciders

func (PutAutoscalingPolicy) Do

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

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

func (*PutAutoscalingPolicy) Header

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

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

func (*PutAutoscalingPolicy) HttpRequest

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

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

func (PutAutoscalingPolicy) Perform

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

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

func (*PutAutoscalingPolicy) Raw

func (r *PutAutoscalingPolicy) Raw(raw io.Reader) *PutAutoscalingPolicy

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*PutAutoscalingPolicy) Request

func (r *PutAutoscalingPolicy) Request(req *Request) *PutAutoscalingPolicy

Request allows to set the request property with the appropriate payload.

func (*PutAutoscalingPolicy) Roles

func (r *PutAutoscalingPolicy) Roles(roles ...string) *PutAutoscalingPolicy

API name: roles

type Request

type Request = types.AutoscalingPolicy

Request holds the request body struct for the package putautoscalingpolicy

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts#L24-L35

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package putautoscalingpolicy

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response