Package org.opensearch.client.opensearch.indices

Class DataStream.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.indices.DataStream.Builder
All Implemented Interfaces:
CopyableBuilder<DataStream.Builder,DataStream>, MutableBuilder<DataStream.Builder,DataStream>, ObjectBuilder<DataStream>
Enclosing class:
DataStream
public static class DataStream.Builder extends ObjectBuilderBase implements CopyableBuilder<DataStream.Builder,DataStream>
Builder for DataStream.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public DataStream.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<DataStream.Builder,DataStream>
      Returns:
      a new builder instance.

    • allowCustomRouting

      @Nonnull public final DataStream.Builder allowCustomRouting(@Nullable Boolean value)
      When true, the data stream allows custom routing on write request.

      API name: allow_custom_routing

    • generation

      @Nonnull public final DataStream.Builder generation(long value)
      Required - The current generation number for the data stream. This number acts as a cumulative count of the stream's rollovers, starting at 1.

      API name: generation

    • hidden

      @Nonnull public final DataStream.Builder hidden(@Nullable Boolean value)
      When true, the data stream is hidden.

      API name: hidden

    • ilmPolicy

      @Nonnull public final DataStream.Builder ilmPolicy(@Nullable String value)
      API name: ilm_policy

    • indices

      @Nonnull public final DataStream.Builder indices(List<DataStreamIndex> list)
      Required - An array of objects containing information about the data stream's backing indexes. The last item in this array contains information about the stream's current write index.

      API name: indices

      Adds all elements of list to indices.

    • indices

      @Nonnull public final DataStream.Builder indices(DataStreamIndex value, DataStreamIndex... values)
      Required - An array of objects containing information about the data stream's backing indexes. The last item in this array contains information about the stream's current write index.

      API name: indices

      Adds one or more values to indices.

    • indices

      @Nonnull public final DataStream.Builder indices(Function<DataStreamIndex.Builder,ObjectBuilder<DataStreamIndex>> fn)
      Required - An array of objects containing information about the data stream's backing indexes. The last item in this array contains information about the stream's current write index.

      API name: indices

      Adds a value to indices using a builder lambda.

    • meta

      @Nonnull public final DataStream.Builder meta(Map<String,JsonData> map)
      API name: _meta

      Adds all elements of map to meta.

    • meta

      @Nonnull public final DataStream.Builder meta(String key, JsonData value)
      API name: _meta

      Adds an entry to meta.

    • name

      @Nonnull public final DataStream.Builder name(String value)
      Required - API name: name

    • nextGenerationManagedBy

      @Nonnull public final DataStream.Builder nextGenerationManagedBy(@Nullable ManagedBy value)
      API name: next_generation_managed_by

    • preferIlm

      @Nonnull public final DataStream.Builder preferIlm(@Nullable Boolean value)
      Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.

      API name: prefer_ilm

    • replicated

      @Nonnull public final DataStream.Builder replicated(@Nullable Boolean value)
      When true, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings.

      API name: replicated

    • status

      @Nonnull public final DataStream.Builder status(HealthStatus value)
      Required - API name: status

    • system

      @Nonnull public final DataStream.Builder system(@Nullable Boolean value)
      When true, the data stream is created and managed by an OpenSearch stack component and cannot be modified through normal user interaction.

      API name: system

    • template

      @Nonnull public final DataStream.Builder template(String value)
      Required - API name: template

    • timestampField

      @Nonnull public final DataStream.Builder timestampField(DataStreamTimestampField value)
      Required - API name: timestamp_field

    • timestampField

      @Nonnull public final DataStream.Builder timestampField(Function<DataStreamTimestampField.Builder,ObjectBuilder<DataStreamTimestampField>> fn)
      Required - API name: timestamp_field

    • build

      @Nonnull public DataStream build()
      Builds a DataStream.
      Specified by:
      build in interface ObjectBuilder<DataStream>
      Throws:
      NullPointerException - if some of the required fields are null.