putautoscalingpolicy

Documentation

Overview

Create or update 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 NewPutAutoscalingPolicy
  • func NewPutAutoscalingPolicyFunc(tp elastictransport.Interface) NewPutAutoscalingPolicy
• type PutAutoscalingPolicy
  • func New(tp elastictransport.Interface) *PutAutoscalingPolicy
  • func (r *PutAutoscalingPolicy) AddDecider(key string, value json.RawMessage) *PutAutoscalingPolicy
  • func (r *PutAutoscalingPolicy) Deciders(deciders map[string]json.RawMessage) *PutAutoscalingPolicy
  • func (r PutAutoscalingPolicy) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutAutoscalingPolicy) ErrorTrace(errortrace bool) *PutAutoscalingPolicy
  • func (r *PutAutoscalingPolicy) FilterPath(filterpaths ...string) *PutAutoscalingPolicy
  • func (r *PutAutoscalingPolicy) Header(key, value string) *PutAutoscalingPolicy
  • func (r *PutAutoscalingPolicy) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutAutoscalingPolicy) Human(human bool) *PutAutoscalingPolicy
  • func (r *PutAutoscalingPolicy) MasterTimeout(duration string) *PutAutoscalingPolicy
  • func (r PutAutoscalingPolicy) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutAutoscalingPolicy) Pretty(pretty bool) *PutAutoscalingPolicy
  • func (r *PutAutoscalingPolicy) Raw(raw io.Reader) *PutAutoscalingPolicy
  • func (r *PutAutoscalingPolicy) Request(req *Request) *PutAutoscalingPolicy
  • func (r *PutAutoscalingPolicy) Roles(roles ...string) *PutAutoscalingPolicy
  • func (r *PutAutoscalingPolicy) Timeout(duration string) *PutAutoscalingPolicy
• type Request
  • func NewRequest() *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

Create or update 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/docs/api/doc/elasticsearch/operation/operation-autoscaling-put-autoscaling-policy

func (*PutAutoscalingPolicy) AddDecider

func (r *PutAutoscalingPolicy) AddDecider(key string, value json.RawMessage) *PutAutoscalingPolicy

func (*PutAutoscalingPolicy) Deciders

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

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

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

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

func (*PutAutoscalingPolicy) FilterPath

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

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

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

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

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 (*PutAutoscalingPolicy) MasterTimeout

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

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

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

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

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

func (*PutAutoscalingPolicy) Timeout

func (r *PutAutoscalingPolicy) Timeout(duration string) *PutAutoscalingPolicy

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

type Request

type Request = types.AutoscalingPolicy

Request holds the request body struct for the package putautoscalingpolicy

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts#L25-L57

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

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/907d11a72a6bfd37b777d526880c56202889609e/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyResponse.ts#L22-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response