Class CreateRequest.Builder<TDocument>
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<CreateRequest.Builder<TDocument>>
co.elastic.clients.elasticsearch.core.CreateRequest.Builder<TDocument>
- All Implemented Interfaces:
WithJson<CreateRequest.Builder<TDocument>>
,ObjectBuilder<CreateRequest<TDocument>>
- Enclosing class:
- CreateRequest<TDocument>
public static class CreateRequest.Builder<TDocument>
extends RequestBase.AbstractBuilder<CreateRequest.Builder<TDocument>>
implements ObjectBuilder<CreateRequest<TDocument>>
Builder for
CreateRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aCreateRequest
.final CreateRequest.Builder<TDocument>
Required - Request body.final CreateRequest.Builder<TDocument>
Required - Unique identifier for the document.final CreateRequest.Builder<TDocument>
Required - Name of the data stream or index to target.final CreateRequest.Builder<TDocument>
ID of the pipeline to use to preprocess incoming documents.final CreateRequest.Builder<TDocument>
Iftrue
, Elasticsearch refreshes the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
do nothing with refreshes.final CreateRequest.Builder<TDocument>
Custom value used to route operations to a specific shard.protected CreateRequest.Builder<TDocument>
self()
final CreateRequest.Builder<TDocument>
Serializer for TDocument.final CreateRequest.Builder<TDocument>
Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.final CreateRequest.Builder<TDocument>
Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.final CreateRequest.Builder<TDocument>
Explicit version number for concurrency control.final CreateRequest.Builder<TDocument>
versionType
(VersionType value) Specific version type:external
,external_gte
.final CreateRequest.Builder<TDocument>
The number of shard copies that must be active before proceeding with the operation.final CreateRequest.Builder<TDocument>
The number of shard copies that must be active before proceeding with the operation.withJson
(jakarta.json.stream.JsonParser parser, JsonpMapper mapper) Sets additional properties values on this object by reading from a JSON input.Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
id
Required - Unique identifier for the document.API name:
id
-
index
Required - Name of the data stream or index to target. If the target doesn’t exist and matches the name or wildcard (*
) pattern of an index template with adata_stream
definition, this request creates the data stream. If the target doesn’t exist and doesn’t match a data stream template, this request creates the index.API name:
index
-
pipeline
ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to_none
disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.API name:
pipeline
-
refresh
Iftrue
, Elasticsearch refreshes the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
do nothing with refreshes. Valid values:true
,false
,wait_for
.API name:
refresh
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-
timeout
Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.API name:
timeout
-
timeout
public final CreateRequest.Builder<TDocument> timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.API name:
timeout
-
version
Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.API name:
version
-
versionType
Specific version type:external
,external_gte
.API name:
version_type
-
waitForActiveShards
public final CreateRequest.Builder<TDocument> waitForActiveShards(@Nullable WaitForActiveShards value) The number of shard copies that must be active before proceeding with the operation. Set toall
or any positive integer up to the total number of shards in the index (number_of_replicas+1
).API name:
wait_for_active_shards
-
waitForActiveShards
public final CreateRequest.Builder<TDocument> waitForActiveShards(Function<WaitForActiveShards.Builder, ObjectBuilder<WaitForActiveShards>> fn) The number of shard copies that must be active before proceeding with the operation. Set toall
or any positive integer up to the total number of shards in the index (number_of_replicas+1
).API name:
wait_for_active_shards
-
document
Required - Request body. -
tDocumentSerializer
public final CreateRequest.Builder<TDocument> tDocumentSerializer(@Nullable JsonpSerializer<TDocument> value) Serializer for TDocument. If not set, an attempt will be made to find a serializer from the JSON context. -
withJson
public CreateRequest.Builder<TDocument> withJson(jakarta.json.stream.JsonParser parser, JsonpMapper mapper) Description copied from interface:WithJson
Sets additional properties values on this object by reading from a JSON input.This is a "partial deserialization": properties that were already set keep their value if they're not present in the JSON input, and properties can also be set after having called this method, including overriding those read from the JSON input.
This low level variant of
withJson
gives full control on the json parser and object mapper. Most of the time usingWithJson.withJson(Reader)
andWithJson.withJson(InputStream)
will be more convenient.- Specified by:
withJson
in interfaceWithJson<TDocument>
- Overrides:
withJson
in classWithJsonObjectBuilderBase<CreateRequest.Builder<TDocument>>
- Parameters:
parser
- the JSONP parsermapper
- the JSONP mapper used to deserialize values and nested objects- Returns:
- this object
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<CreateRequest.Builder<TDocument>>
-
build
Builds aCreateRequest
.- Specified by:
build
in interfaceObjectBuilder<TDocument>
- Throws:
NullPointerException
- if some of the required fields are null.
-