Class DataStream
java.lang.Object
co.elastic.clients.elasticsearch.indices.DataStream
- All Implemented Interfaces:
JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<DataStream>
Json deserializer forDataStream
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Iftrue
, the data stream allows custom routing on write request.final int
Required - Current generation for the data stream.final boolean
hidden()
Required - Iftrue
, the data stream is hidden.final String
Name of the current ILM lifecycle policy in the stream’s matching index template.final List<DataStreamIndex>
indices()
Required - Array of objects containing information about the data stream’s backing indices.Contains the configuration for the data lifecycle management of this data stream.meta()
Custom metadata for the stream, copied from the_meta
object of the stream’s matching index template.final String
name()
Required - Name of the data stream.final ManagedBy
Required - Name of the lifecycle system that'll manage the next generation of the data stream.static DataStream
final boolean
Required - Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.final Boolean
Iftrue
, 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.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
final HealthStatus
status()
Required - Health status of the data stream.final Boolean
system()
Iftrue
, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction.final String
template()
Required - Name of the index template used to create the data stream’s backing indices.final DataStreamTimestampField
Required - Information about the@timestamp
field in the data stream.toString()
-
Field Details
-
_DESERIALIZER
Json deserializer forDataStream
-
-
Method Details
-
of
-
meta
Custom metadata for the stream, copied from the_meta
object of the stream’s matching index template. If empty, the response omits this property.API name:
_meta
-
allowCustomRouting
Iftrue
, the data stream allows custom routing on write request.API name:
allow_custom_routing
-
generation
public final int generation()Required - Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1.API name:
generation
-
ilmPolicy
Name of the current ILM lifecycle policy in the stream’s matching index template. This lifecycle policy is set in theindex.lifecycle.name
setting. If the template does not include a lifecycle policy, this property is not included in the response. NOTE: A data stream’s backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the get index settings API.API name:
ilm_policy
-
nextGenerationManagedBy
Required - Name of the lifecycle system that'll manage the next generation of the data stream.API name:
next_generation_managed_by
-
preferIlm
public final boolean preferIlm()Required - Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.API name:
prefer_ilm
-
indices
Required - Array of objects containing information about the data stream’s backing indices. The last item in this array contains information about the stream’s current write index.API name:
indices
-
lifecycle
Contains the configuration for the data lifecycle management of this data stream.API name:
lifecycle
-
name
Required - Name of the data stream.API name:
name
-
replicated
Iftrue
, 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
Required - Health status of the data stream. This health status is based on the state of the primary and replica shards of the stream’s backing indices.API name:
status
-
system
Iftrue
, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction.API name:
system
-
template
Required - Name of the index template used to create the data stream’s backing indices. The template’s index pattern must match the name of this data stream.API name:
template
-
timestampField
Required - Information about the@timestamp
field in the data stream.API name:
timestamp_field
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
-
setupDataStreamDeserializer
-