Package org.opensearch.client.opensearch.indices

Class DataStream

java.lang.Object
org.opensearch.client.opensearch.indices.DataStream
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<DataStream.Builder,DataStream>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class DataStream extends Object implements PlainJsonSerializable, ToCopyableBuilder<DataStream.Builder,DataStream>

  • Field Details

  • Method Details

    • of

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

    • allowCustomRouting

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

      API name: allow_custom_routing

    • generation

      public final long generation()
      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

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

      API name: hidden

    • ilmPolicy

      @Nullable public final String ilmPolicy()
      API name: ilm_policy

    • indices

      @Nonnull public final List<DataStreamIndex> indices()
      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

    • meta

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

    • name

      @Nonnull public final String name()
      Required - API name: name

    • nextGenerationManagedBy

      @Nullable public final ManagedBy nextGenerationManagedBy()
      API name: next_generation_managed_by

    • preferIlm

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

      API name: prefer_ilm

    • replicated

      @Nullable public final Boolean replicated()
      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 HealthStatus status()
      Required - API name: status

    • system

      @Nullable public final Boolean system()
      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 String template()
      Required - API name: template

    • timestampField

      @Nonnull public final DataStreamTimestampField timestampField()
      Required - API name: timestamp_field

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

    • toBuilder

      @Nonnull public DataStream.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DataStream.Builder,DataStream>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static DataStream.Builder builder()

    • setupDataStreamDeserializer

      protected static void setupDataStreamDeserializer(ObjectDeserializer<DataStream.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object