Package co.elastic.clients.elasticsearch.indices

Class IndexSettingsLifecycle.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<IndexSettingsLifecycle.Builder>
co.elastic.clients.elasticsearch.indices.IndexSettingsLifecycle.Builder
All Implemented Interfaces:
WithJson<IndexSettingsLifecycle.Builder>, ObjectBuilder<IndexSettingsLifecycle>
Enclosing class:
IndexSettingsLifecycle
public static class IndexSettingsLifecycle.Builder
extends WithJsonObjectBuilderBase<IndexSettingsLifecycle.Builder>
implements ObjectBuilder<IndexSettingsLifecycle>
Builder for IndexSettingsLifecycle.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • name

      public final IndexSettingsLifecycle.Builder name​(java.lang.String value)
      Required - 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

      public final IndexSettingsLifecycle.Builder indexingComplete​(@Nullable java.lang.Boolean value)
      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

      public final IndexSettingsLifecycle.Builder originationDate​(@Nullable java.lang.Long value)
      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

      public final IndexSettingsLifecycle.Builder parseOriginationDate​(@Nullable java.lang.Boolean value)
      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

      public final IndexSettingsLifecycle.Builder step​(@Nullable IndexSettingsLifecycleStep value)
      API name: step

    • step

      public final IndexSettingsLifecycle.Builder step​(java.util.function.Function<IndexSettingsLifecycleStep.Builder,​ObjectBuilder<IndexSettingsLifecycleStep>> fn)
      API name: step

    • rolloverAlias

      public final IndexSettingsLifecycle.Builder rolloverAlias​(@Nullable java.lang.String value)
      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

    • self

      protected IndexSettingsLifecycle.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<IndexSettingsLifecycle.Builder>

    • build

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