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

Class UpdatedDataStreamSettings

java.lang.Object
co.elastic.clients.elasticsearch.indices.put_data_stream_settings.UpdatedDataStreamSettings
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class UpdatedDataStreamSettings extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

      public static UpdatedDataStreamSettings of(Function<UpdatedDataStreamSettings.Builder,ObjectBuilder<UpdatedDataStreamSettings>> fn)

    • name

      public final String name()
      Required - The data stream name.

      API name: name

    • appliedToDataStream

      public final boolean appliedToDataStream()
      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

      @Nullable public final String error()
      A message explaining why the settings could not be applied to the data stream.

      API name: error

    • settings

      public final IndexSettings settings()
      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 IndexSettings effectiveSettings()
      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 IndexSettingResults indexSettingsResults()
      Required - Information about whether and where each setting was applied.

      API name: index_settings_results

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupUpdatedDataStreamSettingsDeserializer

      protected static void setupUpdatedDataStreamSettingsDeserializer(ObjectDeserializer<UpdatedDataStreamSettings.Builder> op)