Package co.elastic.clients.elasticsearch.simulate.ingest

Class IngestDocumentSimulation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.simulate.ingest.IngestDocumentSimulation.Builder

All Implemented Interfaces:

WithJson<IngestDocumentSimulation.Builder>, ObjectBuilder<IngestDocumentSimulation>

Enclosing class:

IngestDocumentSimulation

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

Builder for IngestDocumentSimulation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IngestDocumentSimulation	build()	Builds a IngestDocumentSimulation.
final IngestDocumentSimulation.Builder	effectiveMapping(TypeMapping value)	API name: effective_mapping
final IngestDocumentSimulation.Builder	effectiveMapping(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	API name: effective_mapping
final IngestDocumentSimulation.Builder	error(ErrorCause value)	Any error resulting from simulatng ingest on this doc.
final IngestDocumentSimulation.Builder	error(Function<ErrorCause.Builder,ObjectBuilder<ErrorCause>> fn)	Any error resulting from simulatng ingest on this doc.
final IngestDocumentSimulation.Builder	executedPipelines(String value, String... values)	Required - A list of the names of the pipelines executed on this document.
final IngestDocumentSimulation.Builder	executedPipelines(List<String> list)	Required - A list of the names of the pipelines executed on this document.
final IngestDocumentSimulation.Builder	id(String value)	Required - Identifier for the document.
final IngestDocumentSimulation.Builder	ignoredFields(List<Map<String,String>> list)	A list of the fields that would be ignored at the indexing step.
final IngestDocumentSimulation.Builder	ignoredFields(Map<String,String> value, Map<String,String>... values)	A list of the fields that would be ignored at the indexing step.
final IngestDocumentSimulation.Builder	index(String value)	Required - Name of the index that the document would be indexed into if this were not a simulation.
final IngestDocumentSimulation.Builder	metadata(String key, String value)	Additional metadata
final IngestDocumentSimulation.Builder	metadata(Map<String,String> map)	Additional metadata
protected IngestDocumentSimulation.Builder	self()
final IngestDocumentSimulation.Builder	source(String key, JsonData value)	Required - JSON body for the document.
final IngestDocumentSimulation.Builder	source(Map<String,JsonData> map)	Required - JSON body for the document.
final IngestDocumentSimulation.Builder	version(long value)	Required -

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

metadata

public final IngestDocumentSimulation.Builder metadata(Map<String,String> map)

Additional metadata

Adds all entries of map to metadata.

metadata

public final IngestDocumentSimulation.Builder metadata(String key,
 String value)

Additional metadata

Adds an entry to metadata.

id

public final IngestDocumentSimulation.Builder id(String value)

Required - Identifier for the document.

API name: _id

index

public final IngestDocumentSimulation.Builder index(String value)

Required - Name of the index that the document would be indexed into if this were not a simulation.

API name: _index

source

public final IngestDocumentSimulation.Builder source(Map<String,JsonData> map)

Required - JSON body for the document.

API name: _source

Adds all entries of map to source.

source

public final IngestDocumentSimulation.Builder source(String key,
 JsonData value)

Required - JSON body for the document.

API name: _source

Adds an entry to source.

version

public final IngestDocumentSimulation.Builder version(long value)

Required -

API name: _version

executedPipelines

public final IngestDocumentSimulation.Builder executedPipelines(List<String> list)

Required - A list of the names of the pipelines executed on this document.

API name: executed_pipelines

Adds all elements of list to executedPipelines.

executedPipelines

public final IngestDocumentSimulation.Builder executedPipelines(String value,
 String... values)

Required - A list of the names of the pipelines executed on this document.

API name: executed_pipelines

Adds one or more values to executedPipelines.

ignoredFields

public final IngestDocumentSimulation.Builder ignoredFields(List<Map<String,String>> list)

A list of the fields that would be ignored at the indexing step. For example, a field whose value is larger than the allowed limit would make it through all of the pipelines, but would not be indexed into Elasticsearch.

API name: ignored_fields

Adds all elements of list to ignoredFields.

ignoredFields

public final IngestDocumentSimulation.Builder ignoredFields(Map<String,String> value,
 Map<String,String>... values)

A list of the fields that would be ignored at the indexing step. For example, a field whose value is larger than the allowed limit would make it through all of the pipelines, but would not be indexed into Elasticsearch.

API name: ignored_fields

Adds one or more values to ignoredFields.

error

public final IngestDocumentSimulation.Builder error(@Nullable
 ErrorCause value)

Any error resulting from simulatng ingest on this doc. This can be an error generated by executing a processor, or a mapping validation error when simulating indexing the resulting doc.

API name: error

error

public final IngestDocumentSimulation.Builder error(Function<ErrorCause.Builder,ObjectBuilder<ErrorCause>> fn)

Any error resulting from simulatng ingest on this doc. This can be an error generated by executing a processor, or a mapping validation error when simulating indexing the resulting doc.

API name: error

effectiveMapping

public final IngestDocumentSimulation.Builder effectiveMapping(@Nullable
 TypeMapping value)

API name: effective_mapping

effectiveMapping

public final IngestDocumentSimulation.Builder effectiveMapping(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)

API name: effective_mapping

self

protected IngestDocumentSimulation.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<IngestDocumentSimulation.Builder>

build

public IngestDocumentSimulation build()

Builds a IngestDocumentSimulation.

Specified by:

build in interface ObjectBuilder<IngestDocumentSimulation>

Throws:

NullPointerException - if some of the required fields are null.