Class IndexSettingsLifecycle
java.lang.Object
co.elastic.clients.elasticsearch.indices.IndexSettingsLifecycle
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class IndexSettingsLifecycle extends java.lang.Object implements JsonpSerializable
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IndexSettingsLifecycle.Builder
Builder forIndexSettingsLifecycle
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<IndexSettingsLifecycle>
_DESERIALIZER
Json deserializer forIndexSettingsLifecycle
-
Method Summary
Modifier and Type Method Description java.lang.Boolean
indexingComplete()
Indicates whether or not the index has been rolled over.java.lang.String
name()
Required - The name of the policy to use to manage the index.static IndexSettingsLifecycle
of(java.util.function.Function<IndexSettingsLifecycle.Builder,ObjectBuilder<IndexSettingsLifecycle>> fn)
java.lang.Long
originationDate()
If specified, this is the timestamp used to calculate the index age for its phase transitions.java.lang.Boolean
parseOriginationDate()
Set to true to parse the origination date from the index name.java.lang.String
rolloverAlias()
The index alias to update when the index rolls over.void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this object to JSON.protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupIndexSettingsLifecycleDeserializer(ObjectDeserializer<IndexSettingsLifecycle.Builder> op)
IndexSettingsLifecycleStep
step()
API name:step
java.lang.String
toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forIndexSettingsLifecycle
-
-
Method Details
-
of
public static IndexSettingsLifecycle of(java.util.function.Function<IndexSettingsLifecycle.Builder,ObjectBuilder<IndexSettingsLifecycle>> fn) -
name
public final java.lang.String name()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
@Nullable public final java.lang.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 java.lang.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 java.lang.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
API name:step
-
rolloverAlias
@Nullable public final java.lang.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
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
setupIndexSettingsLifecycleDeserializer
protected static void setupIndexSettingsLifecycleDeserializer(ObjectDeserializer<IndexSettingsLifecycle.Builder> op)
-