Package co.elastic.clients.elasticsearch.ml

Class DataframeAnalyticsSource.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<DataframeAnalyticsSource.Builder>

co.elastic.clients.elasticsearch.ml.DataframeAnalyticsSource.Builder

All Implemented Interfaces:

WithJson<DataframeAnalyticsSource.Builder>, ObjectBuilder<DataframeAnalyticsSource>

Enclosing class:

DataframeAnalyticsSource

public static class DataframeAnalyticsSource.Builder
extends WithJsonObjectBuilderBase<DataframeAnalyticsSource.Builder>
implements ObjectBuilder<DataframeAnalyticsSource>

Builder for DataframeAnalyticsSource.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DataframeAnalyticsSource	build()	Builds a DataframeAnalyticsSource.
final DataframeAnalyticsSource.Builder	index(String value, String... values)	Required - Index or indices on which to perform the analysis.
final DataframeAnalyticsSource.Builder	index(List<String> list)	Required - Index or indices on which to perform the analysis.
final DataframeAnalyticsSource.Builder	query(Query value)	The Elasticsearch query domain-specific language (DSL).
final DataframeAnalyticsSource.Builder	query(QueryVariant value)	The Elasticsearch query domain-specific language (DSL).
final DataframeAnalyticsSource.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	The Elasticsearch query domain-specific language (DSL).
final DataframeAnalyticsSource.Builder	runtimeMappings(String key, RuntimeField value)	Definitions of runtime fields that will become part of the mapping of the destination index.
final DataframeAnalyticsSource.Builder	runtimeMappings(String key, Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)	Definitions of runtime fields that will become part of the mapping of the destination index.
final DataframeAnalyticsSource.Builder	runtimeMappings(Map<String,RuntimeField> map)	Definitions of runtime fields that will become part of the mapping of the destination index.
protected DataframeAnalyticsSource.Builder	self()
final DataframeAnalyticsSource.Builder	source(DataframeAnalysisAnalyzedFields value)	Specify includes and/or `excludes patterns to select which fields will be present in the destination.
final DataframeAnalyticsSource.Builder	source(Function<DataframeAnalysisAnalyzedFields.Builder,ObjectBuilder<DataframeAnalysisAnalyzedFields>> fn)	Specify includes and/or `excludes patterns to select which fields will be present in the destination.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

index

public final DataframeAnalyticsSource.Builder index(List<String> list)

Required - Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index.

API name: index

Adds all elements of list to index.

index

public final DataframeAnalyticsSource.Builder index(String value,
 String... values)

Required - Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index.

API name: index

Adds one or more values to index.

query

public final DataframeAnalyticsSource.Builder query(@Nullable
 Query value)

The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}.

API name: query

query

public final DataframeAnalyticsSource.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)

The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}.

API name: query

query

public final DataframeAnalyticsSource.Builder query(QueryVariant value)

The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}.

API name: query

runtimeMappings

public final DataframeAnalyticsSource.Builder runtimeMappings(Map<String,RuntimeField> map)

Definitions of runtime fields that will become part of the mapping of the destination index.

API name: runtime_mappings

Adds all entries of map to runtimeMappings.

runtimeMappings

public final DataframeAnalyticsSource.Builder runtimeMappings(String key,
 RuntimeField value)

Definitions of runtime fields that will become part of the mapping of the destination index.

API name: runtime_mappings

Adds an entry to runtimeMappings.

runtimeMappings

public final DataframeAnalyticsSource.Builder runtimeMappings(String key,
 Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)

Definitions of runtime fields that will become part of the mapping of the destination index.

API name: runtime_mappings

Adds an entry to runtimeMappings using a builder lambda.

source

public final DataframeAnalyticsSource.Builder source(@Nullable
 DataframeAnalysisAnalyzedFields value)

Specify includes and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis.

API name: _source

source

public final DataframeAnalyticsSource.Builder source(Function<DataframeAnalysisAnalyzedFields.Builder,ObjectBuilder<DataframeAnalysisAnalyzedFields>> fn)

Specify includes and/or `excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis.

API name: _source

self

protected DataframeAnalyticsSource.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<DataframeAnalyticsSource.Builder>

build

public DataframeAnalyticsSource build()

Builds a DataframeAnalyticsSource.

Specified by:

build in interface ObjectBuilder<DataframeAnalyticsSource>

Throws:

NullPointerException - if some of the required fields are null.