Class CreateRequest<TDocument>
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch._core.CreateRequest<TDocument>
- All Implemented Interfaces:
ElasticsearchCommonRequest
,JsonpSerializable
public final class CreateRequest<TDocument> extends RequestBase implements JsonpSerializable
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CreateRequest.Builder<TDocument>
Builder forCreateRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<CreateRequest<?>,CreateResponse,ElasticsearchError>
ENDPOINT
Endpoint "create
". -
Constructor Summary
Constructors Constructor Description CreateRequest(CreateRequest.Builder<TDocument> builder)
CreateRequest(java.util.function.Function<CreateRequest.Builder<TDocument>,CreateRequest.Builder<TDocument>> fn)
-
Method Summary
Modifier and Type Method Description static <TDocument>
JsonpDeserializer<CreateRequest<TDocument>>createCreateRequestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)
TDocument
document()
Required - Request body.java.lang.String
id()
Required - Document IDjava.lang.String
index()
Required - The name of the indexjava.lang.String
pipeline()
The pipeline id to preprocess incoming documents withjakarta.json.JsonValue
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.java.lang.String
routing()
Specific routing valuevoid
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this value to JSON.java.lang.String
timeout()
Explicit operation timeoutjava.lang.String
type()
The type of the documentjava.lang.Long
version()
Explicit version number for concurrency controlVersionType
versionType()
Specific version typejakarta.json.JsonValue
waitForActiveShards()
Sets the number of shard copies that must be active before proceeding with the index operation.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
ENDPOINT
Endpoint "create
".
-
-
Constructor Details
-
CreateRequest
-
CreateRequest
public CreateRequest(java.util.function.Function<CreateRequest.Builder<TDocument>,CreateRequest.Builder<TDocument>> fn)
-
-
Method Details
-
id
public java.lang.String id()Required - Document IDAPI name:
id
-
index
public java.lang.String index()Required - The name of the indexAPI name:
index
-
type
@Nullable public java.lang.String type()The type of the documentAPI name:
type
-
pipeline
@Nullable public java.lang.String pipeline()The pipeline id to preprocess incoming documents withAPI name:
pipeline
-
refresh
@Nullable public jakarta.json.JsonValue 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
@Nullable public java.lang.String routing()Specific routing valueAPI name:
routing
-
timeout
@Nullable public java.lang.String timeout()Explicit operation timeoutAPI name:
timeout
-
version
@Nullable public java.lang.Long version()Explicit version number for concurrency controlAPI name:
version
-
versionType
Specific version typeAPI name:
version_type
-
waitForActiveShards
@Nullable public jakarta.json.JsonValue waitForActiveShards()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.API name:
_value_body
-
serialize
Serialize this value to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
createCreateRequestDeserializer
public static <TDocument> JsonpDeserializer<CreateRequest<TDocument>> createCreateRequestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)
-