Package org.opensearch.client.opensearch.indices

Class IndexSettingsLifecycle

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

  • Field Details

  • Method Details

    • of

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

    • indexingComplete

      @Nullable public final Boolean indexingComplete()
      API name: indexing_complete

    • name

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

    • originationDate

      @Nullable public final Long originationDate()
      The timestamp used to calculate the index age for its phase transitions. Use this setting if you create a new index that contains old data and want to use the original creation date to calculate the index age. Specified as a Unix epoch value in milliseconds.

      API name: origination_date

    • parseOriginationDate

      @Nullable public final Boolean parseOriginationDate()
      When true, parses the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, for example logs-2016.10.31-000002). If the index name doesn't match the pattern, index creation fails.

      API name: parse_origination_date

    • rolloverAlias

      @Nullable public final String rolloverAlias()
      The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more information about rolling indexes, see Rollover.

      API name: rollover_alias

    • step

      @Nullable public final IndexSettingsLifecycleStep step()
      API name: step

    • 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 IndexSettingsLifecycle.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<IndexSettingsLifecycle.Builder,IndexSettingsLifecycle>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static IndexSettingsLifecycle.Builder builder()

    • setupIndexSettingsLifecycleDeserializer

      protected static void setupIndexSettingsLifecycleDeserializer(ObjectDeserializer<IndexSettingsLifecycle.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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