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 - Document IDfinal CreateRequest.Builder<TDocument>
Required - The name of the indexfinal CreateRequest.Builder<TDocument>
The pipeline id to preprocess incoming documents withfinal CreateRequest.Builder<TDocument>
Iftrue
then refresh 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
(the default) then do nothing with refreshes.final CreateRequest.Builder<TDocument>
Specific routing valueprotected CreateRequest.Builder<TDocument>
self()
final CreateRequest.Builder<TDocument>
Serializer for TDocument.final CreateRequest.Builder<TDocument>
Explicit operation timeoutfinal CreateRequest.Builder<TDocument>
Explicit operation timeoutfinal CreateRequest.Builder<TDocument>
Explicit version number for concurrency controlfinal CreateRequest.Builder<TDocument>
versionType
(VersionType value) Specific version typefinal CreateRequest.Builder<TDocument>
Sets the number of shard copies that must be active before proceeding with the index operation.final CreateRequest.Builder<TDocument>
Sets the number of shard copies that must be active before proceeding with the index 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 - Document IDAPI name:
id
-
index
Required - The name of the indexAPI name:
index
-
pipeline
The pipeline id to preprocess incoming documents withAPI name:
pipeline
-
refresh
Iftrue
then refresh 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
(the default) then do nothing with refreshes.API name:
refresh
-
routing
Specific routing valueAPI name:
routing
-
timeout
Explicit operation timeoutAPI name:
timeout
-
timeout
public final CreateRequest.Builder<TDocument> timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Explicit operation timeoutAPI name:
timeout
-
version
Explicit version number for concurrency controlAPI name:
version
-
versionType
Specific version typeAPI name:
version_type
-
waitForActiveShards
public final CreateRequest.Builder<TDocument> waitForActiveShards(@Nullable WaitForActiveShards value) Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set toall
for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)API name:
wait_for_active_shards
-
waitForActiveShards
public final CreateRequest.Builder<TDocument> waitForActiveShards(Function<WaitForActiveShards.Builder, ObjectBuilder<WaitForActiveShards>> fn) Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set toall
for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (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.
-