putdatastreamsettings

package
v9.1.0 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2025 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Update data stream settings.

This API can be used to override settings on specific data streams. These overrides will take precedence over what is specified in the template that the data stream matches. To prevent your data stream from getting into an invalid state, only certain settings are allowed. If possible, the setting change is applied to all backing indices. Otherwise, it will be applied when the data stream is next rolled over.

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 NewPutDataStreamSettings 

type NewPutDataStreamSettings func(name string) *PutDataStreamSettings

NewPutDataStreamSettings type alias for index.

func NewPutDataStreamSettingsFunc 

func NewPutDataStreamSettingsFunc(tp elastictransport.Interface) NewPutDataStreamSettings

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

type PutDataStreamSettings 

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

func New 

func New(tp elastictransport.Interface) *PutDataStreamSettings

Update data stream settings.

This API can be used to override settings on specific data streams. These overrides will take precedence over what is specified in the template that the data stream matches. To prevent your data stream from getting into an invalid state, only certain settings are allowed. If possible, the setting change is applied to all backing indices. Otherwise, it will be applied when the data stream is next rolled over.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-settings

func (*PutDataStreamSettings) AddIndexSetting 

func (r *PutDataStreamSettings) AddIndexSetting(key string, value json.RawMessage) *PutDataStreamSettings

func (*PutDataStreamSettings) AddSimilarity 

func (r *PutDataStreamSettings) AddSimilarity(key string, value types.SettingsSimilarityVariant) *PutDataStreamSettings

func (*PutDataStreamSettings) Analysis 

func (r *PutDataStreamSettings) Analysis(analysis types.IndexSettingsAnalysisVariant) *PutDataStreamSettings

API name: analysis

func (*PutDataStreamSettings) Analyze 

func (r *PutDataStreamSettings) Analyze(analyze types.SettingsAnalyzeVariant) *PutDataStreamSettings

Settings to define analyzers, tokenizers, token filters and character filters. Refer to the linked documentation for step-by-step examples of updating analyzers on existing indices. API name: analyze

func (*PutDataStreamSettings) AutoExpandReplicas 

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

API name: auto_expand_replicas

func (*PutDataStreamSettings) Blocks 

func (r *PutDataStreamSettings) Blocks(blocks types.IndexSettingBlocksVariant) *PutDataStreamSettings

API name: blocks

func (*PutDataStreamSettings) CheckOnStartup 

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

API name: check_on_startup

func (*PutDataStreamSettings) Codec 

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

API name: codec

func (*PutDataStreamSettings) CreationDate 

func (r *PutDataStreamSettings) CreationDate(stringifiedepochtimeunitmillis types.StringifiedEpochTimeUnitMillisVariant) *PutDataStreamSettings

API name: creation_date

func (*PutDataStreamSettings) CreationDateString 

func (r *PutDataStreamSettings) CreationDateString(datetime types.DateTimeVariant) *PutDataStreamSettings

API name: creation_date_string

func (*PutDataStreamSettings) DefaultPipeline 

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

API name: default_pipeline

func (PutDataStreamSettings) Do 

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

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

func (*PutDataStreamSettings) DryRun 

func (r *PutDataStreamSettings) DryRun(dryrun bool) *PutDataStreamSettings

DryRun If `true`, the request does not actually change the settings on any data streams or indices. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied. API name: dry_run

func (*PutDataStreamSettings) ErrorTrace 

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

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

func (*PutDataStreamSettings) FilterPath 

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

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

func (*PutDataStreamSettings) FinalPipeline 

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

API name: final_pipeline

func (*PutDataStreamSettings) Format 

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

API name: format

func (*PutDataStreamSettings) GcDeletes 

func (r *PutDataStreamSettings) GcDeletes(duration types.DurationVariant) *PutDataStreamSettings

API name: gc_deletes

func (*PutDataStreamSettings) Header 

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

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

func (*PutDataStreamSettings) Hidden 

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

API name: hidden

func (*PutDataStreamSettings) Highlight 

func (r *PutDataStreamSettings) Highlight(highlight types.SettingsHighlightVariant) *PutDataStreamSettings

API name: highlight

func (*PutDataStreamSettings) HttpRequest 

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

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

func (*PutDataStreamSettings) Human 

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

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 (*PutDataStreamSettings) Index 

func (r *PutDataStreamSettings) Index(index types.IndexSettingsVariant) *PutDataStreamSettings

API name: index

func (*PutDataStreamSettings) IndexSettings 

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

API name: IndexSettings

func (*PutDataStreamSettings) IndexingPressure 

func (r *PutDataStreamSettings) IndexingPressure(indexingpressure types.IndicesIndexingPressureVariant) *PutDataStreamSettings

Configure indexing back pressure limits. API name: indexing_pressure

func (*PutDataStreamSettings) IndexingSlowlog 

func (r *PutDataStreamSettings) IndexingSlowlog(indexingslowlog types.IndexingSlowlogSettingsVariant) *PutDataStreamSettings

API name: indexing.slowlog

func (*PutDataStreamSettings) Lifecycle 

func (r *PutDataStreamSettings) Lifecycle(lifecycle types.IndexSettingsLifecycleVariant) *PutDataStreamSettings

API name: lifecycle

func (*PutDataStreamSettings) LoadFixedBitsetFiltersEagerly 

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

API name: load_fixed_bitset_filters_eagerly

func (*PutDataStreamSettings) Mapping 

func (r *PutDataStreamSettings) Mapping(mapping types.MappingLimitSettingsVariant) *PutDataStreamSettings

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

func (*PutDataStreamSettings) MasterTimeout 

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

MasterTimeout The 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 (*PutDataStreamSettings) MaxDocvalueFieldsSearch 

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

API name: max_docvalue_fields_search

func (*PutDataStreamSettings) MaxInnerResultWindow 

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

API name: max_inner_result_window

func (*PutDataStreamSettings) MaxNgramDiff 

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

API name: max_ngram_diff

func (*PutDataStreamSettings) MaxRefreshListeners 

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

API name: max_refresh_listeners

func (*PutDataStreamSettings) MaxRegexLength 

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

API name: max_regex_length

func (*PutDataStreamSettings) MaxRescoreWindow 

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

API name: max_rescore_window

func (*PutDataStreamSettings) MaxResultWindow 

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

API name: max_result_window

func (*PutDataStreamSettings) MaxScriptFields 

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

API name: max_script_fields

func (*PutDataStreamSettings) MaxShingleDiff 

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

API name: max_shingle_diff

func (*PutDataStreamSettings) MaxSlicesPerScroll 

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

API name: max_slices_per_scroll

func (*PutDataStreamSettings) MaxTermsCount 

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

API name: max_terms_count

func (*PutDataStreamSettings) Merge 

func (r *PutDataStreamSettings) Merge(merge types.MergeVariant) *PutDataStreamSettings

API name: merge

func (*PutDataStreamSettings) Mode 

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

API name: mode

func (*PutDataStreamSettings) NumberOfReplicas 

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

API name: number_of_replicas

func (*PutDataStreamSettings) NumberOfRoutingShards 

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

API name: number_of_routing_shards

func (*PutDataStreamSettings) NumberOfShards 

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

API name: number_of_shards

func (PutDataStreamSettings) Perform 

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

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

func (*PutDataStreamSettings) Pretty 

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

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

func (*PutDataStreamSettings) Priority 

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

API name: priority

func (*PutDataStreamSettings) ProvidedName 

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

API name: provided_name

func (*PutDataStreamSettings) Queries 

func (r *PutDataStreamSettings) Queries(queries types.QueriesVariant) *PutDataStreamSettings

API name: queries

func (*PutDataStreamSettings) QueryString 

func (r *PutDataStreamSettings) QueryString(querystring types.SettingsQueryStringVariant) *PutDataStreamSettings

API name: query_string

func (*PutDataStreamSettings) Raw 

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

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

func (*PutDataStreamSettings) RefreshInterval 

func (r *PutDataStreamSettings) RefreshInterval(duration types.DurationVariant) *PutDataStreamSettings

API name: refresh_interval

func (*PutDataStreamSettings) Request 

func (r *PutDataStreamSettings) Request(req *Request) *PutDataStreamSettings

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

func (*PutDataStreamSettings) Routing 

func (r *PutDataStreamSettings) Routing(routing types.IndexRoutingVariant) *PutDataStreamSettings

API name: routing

func (*PutDataStreamSettings) RoutingPartitionSize 

func (r *PutDataStreamSettings) RoutingPartitionSize(stringifiedinteger types.StringifiedintegerVariant) *PutDataStreamSettings

API name: routing_partition_size

func (*PutDataStreamSettings) RoutingPath 

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

API name: routing_path

func (*PutDataStreamSettings) Search 

func (r *PutDataStreamSettings) Search(search types.SettingsSearchVariant) *PutDataStreamSettings

API name: search

func (*PutDataStreamSettings) Settings 

func (r *PutDataStreamSettings) Settings(settings types.IndexSettingsVariant) *PutDataStreamSettings

API name: settings

func (*PutDataStreamSettings) Similarity 

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

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

func (*PutDataStreamSettings) SoftDeletes 

func (r *PutDataStreamSettings) SoftDeletes(softdeletes types.SoftDeletesVariant) *PutDataStreamSettings

API name: soft_deletes

func (*PutDataStreamSettings) Sort 

func (r *PutDataStreamSettings) Sort(sort types.IndexSegmentSortVariant) *PutDataStreamSettings

API name: sort

func (*PutDataStreamSettings) Store 

func (r *PutDataStreamSettings) Store(store types.StorageVariant) *PutDataStreamSettings

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

func (*PutDataStreamSettings) TimeSeries 

func (r *PutDataStreamSettings) TimeSeries(timeseries types.IndexSettingsTimeSeriesVariant) *PutDataStreamSettings

API name: time_series

func (*PutDataStreamSettings) Timeout 

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

Timeout The 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 (*PutDataStreamSettings) TopMetricsMaxSize 

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

API name: top_metrics_max_size

func (*PutDataStreamSettings) Translog 

func (r *PutDataStreamSettings) Translog(translog types.TranslogVariant) *PutDataStreamSettings

API name: translog

func (*PutDataStreamSettings) Uuid 

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

API name: uuid

func (*PutDataStreamSettings) VerifiedBeforeClose 

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

API name: verified_before_close

func (*PutDataStreamSettings) Version 

func (r *PutDataStreamSettings) Version(version types.IndexVersioningVariant) *PutDataStreamSettings

API name: version

type Request 

type Request = types.IndexSettings

Request holds the request body struct for the package putdatastreamsettings

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/indices/put_data_stream_settings/IndicesPutDataStreamSettingsRequest.ts#L25-L77

func NewRequest 

func NewRequest() *Request

NewRequest returns a Request

type Response 

type Response struct {
	DataStreams []types.UpdatedDataStreamSettings `json:"data_streams"`
}

Response holds the response body struct for the package putdatastreamsettings

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/indices/put_data_stream_settings/IndicesPutDataStreamSettingsResponse.ts#L23-L28

func NewResponse 

func NewResponse() *Response

NewResponse returns a Response

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.