Class DataStream.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<DataStream.Builder>
co.elastic.clients.elasticsearch.indices.DataStream.Builder
- All Implemented Interfaces:
WithJson<DataStream.Builder>
,ObjectBuilder<DataStream>
- Enclosing class:
- DataStream
public static class DataStream.Builder
extends WithJsonObjectBuilderBase<DataStream.Builder>
implements ObjectBuilder<DataStream>
Builder for
DataStream
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal DataStream.Builder
allowCustomRouting
(Boolean value) Iftrue
, the data stream allows custom routing on write request.build()
Builds aDataStream
.final DataStream.Builder
generation
(int value) Required - Current generation for the data stream.final DataStream.Builder
hidden
(boolean value) Required - Iftrue
, the data stream is hidden.final DataStream.Builder
Name of the current ILM lifecycle policy in the stream’s matching index template.final DataStream.Builder
indices
(DataStreamIndex value, DataStreamIndex... values) Required - Array of objects containing information about the data stream’s backing indices.final DataStream.Builder
Required - Array of objects containing information about the data stream’s backing indices.final DataStream.Builder
indices
(List<DataStreamIndex> list) Required - Array of objects containing information about the data stream’s backing indices.final DataStream.Builder
Contains the configuration for the data lifecycle management of this data stream.final DataStream.Builder
lifecycle
(Function<DataStreamLifecycleWithRollover.Builder, ObjectBuilder<DataStreamLifecycleWithRollover>> fn) Contains the configuration for the data lifecycle management of this data stream.final DataStream.Builder
Custom metadata for the stream, copied from the_meta
object of the stream’s matching index template.final DataStream.Builder
Custom metadata for the stream, copied from the_meta
object of the stream’s matching index template.final DataStream.Builder
Required - Name of the data stream.final DataStream.Builder
nextGenerationManagedBy
(ManagedBy value) Required - Name of the lifecycle system that'll manage the next generation of the data stream.final DataStream.Builder
preferIlm
(boolean value) Required - Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.final DataStream.Builder
replicated
(Boolean value) 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.protected DataStream.Builder
self()
final DataStream.Builder
status
(HealthStatus value) Required - Health status of the data stream.final DataStream.Builder
Iftrue
, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction.final DataStream.Builder
Required - Name of the index template used to create the data stream’s backing indices.final DataStream.Builder
Required - Information about the@timestamp
field in the data stream.final DataStream.Builder
timestampField
(Function<DataStreamTimestampField.Builder, ObjectBuilder<DataStreamTimestampField>> fn) Required - Information about the@timestamp
field in the data stream.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
Adds all entries of
map
tometa
. -
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
Adds an entry to
meta
. -
allowCustomRouting
Iftrue
, the data stream allows custom routing on write request.API name:
allow_custom_routing
-
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
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
Adds all elements of
list
toindices
. -
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
Adds one or more values to
indices
. -
indices
public final DataStream.Builder indices(Function<DataStreamIndex.Builder, ObjectBuilder<DataStreamIndex>> fn) 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
Adds a value to
indices
using a builder lambda. -
lifecycle
Contains the configuration for the data lifecycle management of this data stream.API name:
lifecycle
-
lifecycle
public final DataStream.Builder lifecycle(Function<DataStreamLifecycleWithRollover.Builder, ObjectBuilder<DataStreamLifecycleWithRollover>> fn) 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
-
timestampField
public final DataStream.Builder timestampField(Function<DataStreamTimestampField.Builder, ObjectBuilder<DataStreamTimestampField>> fn) Required - Information about the@timestamp
field in the data stream.API name:
timestamp_field
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<DataStream.Builder>
-
build
Builds aDataStream
.- Specified by:
build
in interfaceObjectBuilder<DataStream>
- Throws:
NullPointerException
- if some of the required fields are null.
-