putsettings

package
v8.18.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 17, 2025 License: Apache-2.0 Imports: 14 Imported by: 4

Documentation

Overview

Update index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.

To revert a setting to the default value, use a null value. The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation. To preserve existing settings from being updated, set the `preserve_existing` parameter to `true`. 

There are multiple valid ways to represent index settings in the request

body. You can specify only the setting, for example:

``` 

{
  "number_of_replicas": 1
}

```

Or you can use an `index` setting object: ``` 

{
  "index": {
    "number_of_replicas": 1
  }
}

```

Or you can use dot annotation: ``` 

{
  "index.number_of_replicas": 1
}

```

Or you can embed any of the aforementioned options in a `settings` object. For example:

``` 

{
  "settings": {
    "index": {
      "number_of_replicas": 1
    }
  }
}

```

NOTE: You can only define new analyzers on closed indices. To add an analyzer, you must close the index, define the analyzer, and reopen the index. You cannot close the write index of a data stream. To update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream. Then roll over the data stream to apply the new analyzer to the stream's write index and future backing indices. This affects searches and any new data added to the stream after the rollover. However, it does not affect the data stream's backing indices or their existing data. To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.

Index

Constants

This section is empty.

Variables

View Source 
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.

Functions

This section is empty.

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 index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.

To revert a setting to the default value, use a null value. The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation. To preserve existing settings from being updated, set the `preserve_existing` parameter to `true`. 

There are multiple valid ways to represent index settings in the request

body. You can specify only the setting, for example:

``` 

{
  "number_of_replicas": 1
}

```

Or you can use an `index` setting object: ``` 

{
  "index": {
    "number_of_replicas": 1
  }
}

```

Or you can use dot annotation: ``` 

{
  "index.number_of_replicas": 1
}

```

Or you can embed any of the aforementioned options in a `settings` object. For example:

``` 

{
  "settings": {
    "index": {
      "number_of_replicas": 1
    }
  }
}

```

NOTE: You can only define new analyzers on closed indices. To add an analyzer, you must close the index, define the analyzer, and reopen the index. You cannot close the write index of a data stream. To update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream. Then roll over the data stream to apply the new analyzer to the stream's write index and future backing indices. This affects searches and any new data added to the stream after the rollover. However, it does not affect the data stream's backing indices or their existing data. To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.

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

func (*PutSettings) AllowNoIndices 

func (r *PutSettings) AllowNoIndices(allownoindices bool) *PutSettings

AllowNoIndices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. API name: allow_no_indices

func (*PutSettings) Analysis added in v8.11.0 

func (r *PutSettings) Analysis(analysis *types.IndexSettingsAnalysis) *PutSettings

API name: analysis

func (*PutSettings) Analyze added in v8.11.0 

func (r *PutSettings) Analyze(analyze *types.SettingsAnalyze) *PutSettings

Analyze Settings to define analyzers, tokenizers, token filters and character filters. API name: analyze

func (*PutSettings) AutoExpandReplicas added in v8.11.0 

func (r *PutSettings) AutoExpandReplicas(autoexpandreplicas any) *PutSettings

API name: auto_expand_replicas

func (*PutSettings) Blocks added in v8.11.0 

func (r *PutSettings) Blocks(blocks *types.IndexSettingBlocks) *PutSettings

API name: blocks

func (*PutSettings) CheckOnStartup added in v8.11.0 

func (r *PutSettings) CheckOnStartup(checkonstartup indexcheckonstartup.IndexCheckOnStartup) *PutSettings

API name: check_on_startup

func (*PutSettings) Codec added in v8.11.0 

func (r *PutSettings) Codec(codec string) *PutSettings

API name: codec

func (*PutSettings) CreationDate added in v8.11.0 

func (r *PutSettings) CreationDate(stringifiedepochtimeunitmillis types.StringifiedEpochTimeUnitMillis) *PutSettings

API name: creation_date

func (*PutSettings) CreationDateString added in v8.11.0 

func (r *PutSettings) CreationDateString(datetime types.DateTime) *PutSettings

API name: creation_date_string

func (*PutSettings) DefaultPipeline added in v8.11.0 

func (r *PutSettings) DefaultPipeline(pipelinename string) *PutSettings

API name: default_pipeline

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 added in v8.14.0 

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

func (r *PutSettings) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *PutSettings

ExpandWildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. API name: expand_wildcards

func (*PutSettings) FilterPath added in v8.14.0 

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) FinalPipeline added in v8.11.0 

func (r *PutSettings) FinalPipeline(pipelinename string) *PutSettings

API name: final_pipeline

func (*PutSettings) FlatSettings 

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

FlatSettings If `true`, returns settings in flat format. API name: flat_settings

func (*PutSettings) Format added in v8.11.0 

func (r *PutSettings) Format(format string) *PutSettings

API name: format

func (*PutSettings) GcDeletes added in v8.11.0 

func (r *PutSettings) GcDeletes(duration types.Duration) *PutSettings

API name: gc_deletes

func (*PutSettings) Header 

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

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

func (*PutSettings) Hidden added in v8.11.0 

func (r *PutSettings) Hidden(hidden string) *PutSettings

API name: hidden

func (*PutSettings) Highlight added in v8.11.0 

func (r *PutSettings) Highlight(highlight *types.SettingsHighlight) *PutSettings

API name: highlight

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 added in v8.14.0 

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

func (r *PutSettings) IgnoreUnavailable(ignoreunavailable bool) *PutSettings

IgnoreUnavailable If `true`, returns settings in flat format. API name: ignore_unavailable

func (*PutSettings) Index 

func (r *PutSettings) Index(index *types.IndexSettings) *PutSettings

API name: index

func (*PutSettings) IndexSettings added in v8.11.0 

func (r *PutSettings) IndexSettings(indexsettings map[string]json.RawMessage) *PutSettings

API name: IndexSettings

func (*PutSettings) IndexingPressure added in v8.11.0 

func (r *PutSettings) IndexingPressure(indexingpressure *types.IndicesIndexingPressure) *PutSettings

IndexingPressure Configure indexing back pressure limits. API name: indexing_pressure

func (*PutSettings) IndexingSlowlog added in v8.11.0 

func (r *PutSettings) IndexingSlowlog(indexingslowlog *types.IndexingSlowlogSettings) *PutSettings

API name: indexing.slowlog

func (*PutSettings) Indices added in v8.11.1 

func (r *PutSettings) Indices(index string) *PutSettings

Indices Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. API Name: index

func (*PutSettings) Lifecycle added in v8.11.0 

func (r *PutSettings) Lifecycle(lifecycle *types.IndexSettingsLifecycle) *PutSettings

API name: lifecycle

func (*PutSettings) LoadFixedBitsetFiltersEagerly added in v8.11.0 

func (r *PutSettings) LoadFixedBitsetFiltersEagerly(loadfixedbitsetfilterseagerly bool) *PutSettings

API name: load_fixed_bitset_filters_eagerly

func (*PutSettings) Mapping added in v8.11.0 

func (r *PutSettings) Mapping(mapping *types.MappingLimitSettings) *PutSettings

Mapping Enable or disable dynamic mapping for an index. API name: mapping

func (*PutSettings) MasterTimeout 

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

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 (*PutSettings) MaxDocvalueFieldsSearch added in v8.11.0 

func (r *PutSettings) MaxDocvalueFieldsSearch(maxdocvaluefieldssearch int) *PutSettings

API name: max_docvalue_fields_search

func (*PutSettings) MaxInnerResultWindow added in v8.11.0 

func (r *PutSettings) MaxInnerResultWindow(maxinnerresultwindow int) *PutSettings

API name: max_inner_result_window

func (*PutSettings) MaxNgramDiff added in v8.11.0 

func (r *PutSettings) MaxNgramDiff(maxngramdiff int) *PutSettings

API name: max_ngram_diff

func (*PutSettings) MaxRefreshListeners added in v8.11.0 

func (r *PutSettings) MaxRefreshListeners(maxrefreshlisteners int) *PutSettings

API name: max_refresh_listeners

func (*PutSettings) MaxRegexLength added in v8.11.0 

func (r *PutSettings) MaxRegexLength(maxregexlength int) *PutSettings

API name: max_regex_length

func (*PutSettings) MaxRescoreWindow added in v8.11.0 

func (r *PutSettings) MaxRescoreWindow(maxrescorewindow int) *PutSettings

API name: max_rescore_window

func (*PutSettings) MaxResultWindow added in v8.11.0 

func (r *PutSettings) MaxResultWindow(maxresultwindow int) *PutSettings

API name: max_result_window

func (*PutSettings) MaxScriptFields added in v8.11.0 

func (r *PutSettings) MaxScriptFields(maxscriptfields int) *PutSettings

API name: max_script_fields

func (*PutSettings) MaxShingleDiff added in v8.11.0 

func (r *PutSettings) MaxShingleDiff(maxshinglediff int) *PutSettings

API name: max_shingle_diff

func (*PutSettings) MaxSlicesPerScroll added in v8.11.0 

func (r *PutSettings) MaxSlicesPerScroll(maxslicesperscroll int) *PutSettings

API name: max_slices_per_scroll

func (*PutSettings) MaxTermsCount added in v8.11.0 

func (r *PutSettings) MaxTermsCount(maxtermscount int) *PutSettings

API name: max_terms_count

func (*PutSettings) Merge added in v8.11.0 

func (r *PutSettings) Merge(merge *types.Merge) *PutSettings

API name: merge

func (*PutSettings) Mode added in v8.11.0 

func (r *PutSettings) Mode(mode string) *PutSettings

API name: mode

func (*PutSettings) NumberOfReplicas added in v8.11.0 

func (r *PutSettings) NumberOfReplicas(numberofreplicas string) *PutSettings

API name: number_of_replicas

func (*PutSettings) NumberOfRoutingShards added in v8.11.0 

func (r *PutSettings) NumberOfRoutingShards(numberofroutingshards int) *PutSettings

API name: number_of_routing_shards

func (*PutSettings) NumberOfShards added in v8.11.0 

func (r *PutSettings) NumberOfShards(numberofshards string) *PutSettings

API name: number_of_shards

func (PutSettings) Perform added in v8.7.0 

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

func (r *PutSettings) PreserveExisting(preserveexisting bool) *PutSettings

PreserveExisting If `true`, existing index settings remain unchanged. API name: preserve_existing

func (*PutSettings) Pretty added in v8.14.0 

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) Priority added in v8.11.0 

func (r *PutSettings) Priority(priority string) *PutSettings

API name: priority

func (*PutSettings) ProvidedName added in v8.11.0 

func (r *PutSettings) ProvidedName(name string) *PutSettings

API name: provided_name

func (*PutSettings) Queries added in v8.11.0 

func (r *PutSettings) Queries(queries *types.Queries) *PutSettings

API name: queries

func (*PutSettings) QueryString added in v8.11.0 

func (r *PutSettings) QueryString(querystring *types.SettingsQueryString) *PutSettings

API name: query_string

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) RefreshInterval added in v8.11.0 

func (r *PutSettings) RefreshInterval(duration types.Duration) *PutSettings

API name: refresh_interval

func (*PutSettings) Reopen added in v8.18.0 

func (r *PutSettings) Reopen(reopen bool) *PutSettings

Reopen Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. API name: reopen

func (*PutSettings) Request 

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

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

func (*PutSettings) Routing added in v8.11.0 

func (r *PutSettings) Routing(routing *types.IndexRouting) *PutSettings

API name: routing

func (*PutSettings) RoutingPartitionSize added in v8.11.0 

func (r *PutSettings) RoutingPartitionSize(stringifiedinteger types.Stringifiedinteger) *PutSettings

API name: routing_partition_size

func (*PutSettings) RoutingPath added in v8.11.0 

func (r *PutSettings) RoutingPath(routingpaths ...string) *PutSettings

API name: routing_path

func (*PutSettings) Search added in v8.11.0 

func (r *PutSettings) Search(search *types.SettingsSearch) *PutSettings

API name: search

func (*PutSettings) Settings added in v8.11.0 

func (r *PutSettings) Settings(settings *types.IndexSettings) *PutSettings

API name: settings

func (*PutSettings) Similarity added in v8.11.0 

func (r *PutSettings) Similarity(similarity map[string]types.SettingsSimilarity) *PutSettings

Similarity Configure custom similarity settings to customize how search results are scored. API name: similarity

func (*PutSettings) SoftDeletes added in v8.11.0 

func (r *PutSettings) SoftDeletes(softdeletes *types.SoftDeletes) *PutSettings

API name: soft_deletes

func (*PutSettings) Sort added in v8.11.0 

func (r *PutSettings) Sort(sort *types.IndexSegmentSort) *PutSettings

API name: sort

func (*PutSettings) Store added in v8.11.0 

func (r *PutSettings) Store(store *types.Storage) *PutSettings

Store The store module allows you to control how index data is stored and accessed on disk. API name: store

func (*PutSettings) TimeSeries added in v8.11.0 

func (r *PutSettings) TimeSeries(timeseries *types.IndexSettingsTimeSeries) *PutSettings

API name: time_series

func (*PutSettings) Timeout 

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

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

func (*PutSettings) TopMetricsMaxSize added in v8.11.0 

func (r *PutSettings) TopMetricsMaxSize(topmetricsmaxsize int) *PutSettings

API name: top_metrics_max_size

func (*PutSettings) Translog added in v8.11.0 

func (r *PutSettings) Translog(translog *types.Translog) *PutSettings

API name: translog

func (*PutSettings) Uuid added in v8.11.0 

func (r *PutSettings) Uuid(uuid string) *PutSettings

API name: uuid

func (*PutSettings) VerifiedBeforeClose added in v8.11.0 

func (r *PutSettings) VerifiedBeforeClose(verifiedbeforeclose string) *PutSettings

API name: verified_before_close

func (*PutSettings) Version added in v8.11.0 

func (r *PutSettings) Version(version *types.IndexVersioning) *PutSettings

API name: version

type Request added in v8.11.0 

type Request = types.IndexSettings

Request holds the request body struct for the package putsettings

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/put_settings/IndicesPutSettingsRequest.ts#L25-L162

func NewRequest added in v8.13.1 

func NewRequest() *Request

NewRequest returns a Request

type Response added in v8.7.0 

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 putsettings

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/put_settings/IndicesPutSettingsResponse.ts#L22-L24

func NewResponse added in v8.7.0 

func NewResponse() *Response

NewResponse returns a Response

Source Files

View all Source files
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.
close