Package co.elastic.clients.elasticsearch.indices

Class IndexSettingsLifecycle

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

  • Field Details

  • Method Details

    • of

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

    • name

      @Nullable public final String name()
      The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates.

      API name: name

    • indexingComplete

      @Nullable public final Boolean indexingComplete()
      Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action. You can explicitly set it to skip rollover.

      API name: indexing_complete

    • originationDate

      @Nullable public final Long originationDate()
      If specified, this is 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()
      Set to true to parse 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

    • step

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

    • 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 indices, see Rollover.

      API name: rollover_alias

    • preferIlm

      @Nullable public final Boolean preferIlm()
      Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are applicable for an index).

      API name: prefer_ilm

    • 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

    • setupIndexSettingsLifecycleDeserializer

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