putsettings

Documentation

Overview

Update the cluster settings. Configure and update dynamic settings on a running cluster. You can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.

Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart. You can also reset transient or persistent settings by assigning them a null value.

If you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value. For example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting. However, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.

TIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster. If you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings. Only use `elasticsearch.yml` for static cluster settings and node settings. The API doesn’t require a restart and ensures a setting’s value is the same on all nodes.

WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead. If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.

Index

• Variables
• type NewPutSettings
  • func NewPutSettingsFunc(tp elastictransport.Interface) NewPutSettings
• type PutSettings
  • func New(tp elastictransport.Interface) *PutSettings
  • func (r PutSettings) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutSettings) ErrorTrace(errortrace bool) *PutSettings
  • func (r *PutSettings) FilterPath(filterpaths ...string) *PutSettings
  • func (r *PutSettings) FlatSettings(flatsettings bool) *PutSettings
  • func (r *PutSettings) Header(key, value string) *PutSettings
  • func (r *PutSettings) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutSettings) Human(human bool) *PutSettings
  • func (r *PutSettings) MasterTimeout(duration string) *PutSettings
  • func (r PutSettings) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutSettings) Persistent(persistent map[string]json.RawMessage) *PutSettings
  • func (r *PutSettings) Pretty(pretty bool) *PutSettings
  • func (r *PutSettings) Raw(raw io.Reader) *PutSettings
  • func (r *PutSettings) Request(req *Request) *PutSettings
  • func (r *PutSettings) Timeout(duration string) *PutSettings
  • func (r *PutSettings) Transient(transient map[string]json.RawMessage) *PutSettings
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• 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 NewPutSettings

type NewPutSettings func() *PutSettings

NewPutSettings type alias for index.

func NewPutSettingsFunc

func NewPutSettingsFunc(tp elastictransport.Interface) NewPutSettings

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

type PutSettings

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

func New

func New(tp elastictransport.Interface) *PutSettings

Update the cluster settings. Configure and update dynamic settings on a running cluster. You can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.

Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart. You can also reset transient or persistent settings by assigning them a null value.

If you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value. For example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting. However, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.

TIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster. If you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings. Only use `elasticsearch.yml` for static cluster settings and node settings. The API doesn’t require a restart and ensures a setting’s value is the same on all nodes.

WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead. If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html

func (PutSettings) Do

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

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

func (*PutSettings) ErrorTrace

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

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

func (*PutSettings) FilterPath

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

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

func (*PutSettings) FlatSettings

func (r *PutSettings) FlatSettings(flatsettings bool) *PutSettings

FlatSettings Return settings in flat format (default: false) API name: flat_settings

func (*PutSettings) Header

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

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

func (*PutSettings) HttpRequest

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

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

func (*PutSettings) Human

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

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

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

MasterTimeout Explicit operation timeout for connection to master node API name: master_timeout

func (PutSettings) Perform

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

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

func (*PutSettings) Persistent

func (r *PutSettings) Persistent(persistent map[string]json.RawMessage) *PutSettings

API name: persistent

func (*PutSettings) Pretty

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

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

func (*PutSettings) Raw

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

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

func (*PutSettings) Request

func (r *PutSettings) Request(req *Request) *PutSettings

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

func (*PutSettings) Timeout

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

Timeout Explicit operation timeout API name: timeout

func (*PutSettings) Transient

func (r *PutSettings) Transient(transient map[string]json.RawMessage) *PutSettings

API name: transient

type Request

type Request struct {
	Persistent map[string]json.RawMessage `json:"persistent,omitempty"`
	Transient  map[string]json.RawMessage `json:"transient,omitempty"`
}

Request holds the request body struct for the package putsettings

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/cluster/put_settings/ClusterPutSettingsRequest.ts#L25-L61

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {
	Acknowledged bool                       `json:"acknowledged"`
	Persistent   map[string]json.RawMessage `json:"persistent"`
	Transient    map[string]json.RawMessage `json:"transient"`
}

Response holds the response body struct for the package putsettings

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/cluster/put_settings/ClusterPutSettingsResponse.ts#L23-L29

func NewResponse

func NewResponse() *Response

NewResponse returns a Response