Package co.elastic.clients.elasticsearch.indices.put_data_stream_settings

Class UpdatedDataStreamSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<UpdatedDataStreamSettings.Builder>

co.elastic.clients.elasticsearch.indices.put_data_stream_settings.UpdatedDataStreamSettings.Builder

All Implemented Interfaces:

WithJson<UpdatedDataStreamSettings.Builder>, ObjectBuilder<UpdatedDataStreamSettings>

Enclosing class:

UpdatedDataStreamSettings

public static class UpdatedDataStreamSettings.Builder
extends WithJsonObjectBuilderBase<UpdatedDataStreamSettings.Builder>
implements ObjectBuilder<UpdatedDataStreamSettings>

Builder for UpdatedDataStreamSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final UpdatedDataStreamSettings.Builder	appliedToDataStream(boolean value)	Required - If the settings were successfully applied to the data stream (or would have been, if running in dry_run mode), it is true.
UpdatedDataStreamSettings	build()	Builds a UpdatedDataStreamSettings.
final UpdatedDataStreamSettings.Builder	effectiveSettings(IndexSettings value)	Required - The settings that are effective on this data stream, taking into account the settings from the matching index template and the settings specific to this data stream.
final UpdatedDataStreamSettings.Builder	effectiveSettings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	Required - The settings that are effective on this data stream, taking into account the settings from the matching index template and the settings specific to this data stream.
final UpdatedDataStreamSettings.Builder	error(String value)	A message explaining why the settings could not be applied to the data stream.
final UpdatedDataStreamSettings.Builder	indexSettingsResults(IndexSettingResults value)	Required - Information about whether and where each setting was applied.
final UpdatedDataStreamSettings.Builder	indexSettingsResults(Function<IndexSettingResults.Builder,ObjectBuilder<IndexSettingResults>> fn)	Required - Information about whether and where each setting was applied.
final UpdatedDataStreamSettings.Builder	name(String value)	Required - The data stream name.
protected UpdatedDataStreamSettings.Builder	self()
final UpdatedDataStreamSettings.Builder	settings(IndexSettings value)	Required - The settings that are specfic to this data stream that will override any settings from the matching index template.
final UpdatedDataStreamSettings.Builder	settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	Required - The settings that are specfic to this data stream that will override any settings from the matching index template.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

name

public final UpdatedDataStreamSettings.Builder name(String value)

Required - The data stream name.

API name: name

appliedToDataStream

public final UpdatedDataStreamSettings.Builder appliedToDataStream(boolean value)

Required - If the settings were successfully applied to the data stream (or would have been, if running in dry_run mode), it is true. If an error occurred, it is false.

API name: applied_to_data_stream

error

public final UpdatedDataStreamSettings.Builder error(@Nullable
 String value)

A message explaining why the settings could not be applied to the data stream.

API name: error

settings

public final UpdatedDataStreamSettings.Builder settings(IndexSettings value)

Required - The settings that are specfic to this data stream that will override any settings from the matching index template.

API name: settings

settings

public final UpdatedDataStreamSettings.Builder settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)

Required - The settings that are specfic to this data stream that will override any settings from the matching index template.

API name: settings

effectiveSettings

public final UpdatedDataStreamSettings.Builder effectiveSettings(IndexSettings value)

Required - The settings that are effective on this data stream, taking into account the settings from the matching index template and the settings specific to this data stream.

API name: effective_settings

effectiveSettings

public final UpdatedDataStreamSettings.Builder effectiveSettings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)

Required - The settings that are effective on this data stream, taking into account the settings from the matching index template and the settings specific to this data stream.

API name: effective_settings

indexSettingsResults

public final UpdatedDataStreamSettings.Builder indexSettingsResults(IndexSettingResults value)

Required - Information about whether and where each setting was applied.

API name: index_settings_results

indexSettingsResults

public final UpdatedDataStreamSettings.Builder indexSettingsResults(Function<IndexSettingResults.Builder,ObjectBuilder<IndexSettingResults>> fn)

Required - Information about whether and where each setting was applied.

API name: index_settings_results

self

protected UpdatedDataStreamSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<UpdatedDataStreamSettings.Builder>

build

public UpdatedDataStreamSettings build()

Builds a UpdatedDataStreamSettings.

Specified by:

build in interface ObjectBuilder<UpdatedDataStreamSettings>

Throws:

NullPointerException - if some of the required fields are null.