public class IndexRequest extends ReplicatedWriteRequest<IndexRequest> implements DocumentRequest<IndexRequest>
Requests.indexRequest(String)
.
The index requires the ReplicationRequest.index()
, type(String)
, id(String)
and
source(byte[])
to be set.
The source (content to index) can be set in its bytes form using (source(byte[])
),
its string form (source(String)
) or using a XContentBuilder
(source(org.elasticsearch.common.xcontent.XContentBuilder)
).
If the id(String)
is not set, it will be automatically generated.Modifier and Type | Class and Description |
---|---|
static class |
IndexRequest.OpType
Operation type controls if the type of the index operation.
|
TransportRequest.Empty
IndicesRequest.Replaceable
WriteRequest.RefreshPolicy
Modifier and Type | Field and Description |
---|---|
static int |
UNSET_AUTO_GENERATED_TIMESTAMP
Value for
getAutoGeneratedTimestamp() if the document has an external
provided ID. |
DEFAULT_TIMEOUT, index, shardId, timeout, waitForActiveShards
Constructor and Description |
---|
IndexRequest() |
IndexRequest(java.lang.String index)
Constructs a new index request against the specific index.
|
IndexRequest(java.lang.String index,
java.lang.String type)
Constructs a new index request against the specific index and type.
|
IndexRequest(java.lang.String index,
java.lang.String type,
java.lang.String id)
Constructs a new index request against the index, type, id and using the source.
|
Modifier and Type | Method and Description |
---|---|
IndexRequest |
contentType(XContentType contentType)
Sets the content type that will be used when generating a document from user provided objects (like Map).
|
IndexRequest |
create(boolean create)
Set to true to force this index to use
IndexRequest.OpType.CREATE . |
long |
getAutoGeneratedTimestamp()
Returns the timestamp the auto generated ID was created or -1 if the
document has no auto generated timestamp.
|
XContentType |
getContentType()
The content type that will be used when generating a document from user provided objects like Maps.
|
java.lang.String |
getPipeline()
Returns the ingest pipeline to be executed before indexing the document
|
java.lang.String |
id()
The id of the indexed document.
|
IndexRequest |
id(java.lang.String id)
Sets the id of the indexed document.
|
boolean |
isRetry()
Returns
true if this request has been sent to a shard copy more than once. |
void |
onRetry()
This method is called before this replication request is retried
the first time.
|
IndexRequest.OpType |
opType()
The type of operation to perform.
|
IndexRequest |
opType(IndexRequest.OpType opType)
Sets the type of operation to perform.
|
IndexRequest |
opType(java.lang.String opType)
Sets a string representation of the
opType(org.elasticsearch.action.index.IndexRequest.OpType) . |
java.lang.String |
parent()
Get the parent for this request
|
IndexRequest |
parent(java.lang.String parent)
Sets the parent id of this document.
|
void |
process(MappingMetaData mappingMd,
boolean allowIdGeneration,
java.lang.String concreteIndex) |
void |
readFrom(StreamInput in)
Set this object's fields from a StreamInput.
|
void |
resolveRouting(MetaData metaData) |
java.lang.String |
routing()
Controls the shard routing of the request.
|
IndexRequest |
routing(java.lang.String routing)
Controls the shard routing of the request.
|
IndexRequest |
setPipeline(java.lang.String pipeline)
Sets the ingest pipeline to be executed before indexing the document
|
BytesReference |
source()
The source of the document to index, recopied to a new array if it is unsafe.
|
IndexRequest |
source(byte[] source)
Sets the document to index in bytes form.
|
IndexRequest |
source(byte[] source,
int offset,
int length)
Sets the document to index in bytes form (assumed to be safe to be used from different
threads).
|
IndexRequest |
source(BytesReference source)
Sets the document to index in bytes form.
|
IndexRequest |
source(java.util.Map source)
Index the Map as a
Requests.INDEX_CONTENT_TYPE . |
IndexRequest |
source(java.util.Map source,
XContentType contentType)
Index the Map as the provided content type.
|
IndexRequest |
source(java.lang.Object... source)
Sets the content source to index.
|
IndexRequest |
source(java.lang.String source)
Sets the document source to index.
|
IndexRequest |
source(XContentBuilder sourceBuilder)
Sets the content source to index.
|
java.util.Map<java.lang.String,java.lang.Object> |
sourceAsMap() |
java.lang.String |
timestamp()
Deprecated.
|
IndexRequest |
timestamp(java.lang.String timestamp)
Deprecated.
|
java.lang.String |
toString() |
TimeValue |
ttl()
Deprecated.
|
IndexRequest |
ttl(long ttl)
Deprecated.
|
IndexRequest |
ttl(java.lang.String ttl)
Deprecated.
|
IndexRequest |
ttl(TimeValue ttl)
Deprecated.
|
java.lang.String |
type()
The type of the indexed document.
|
IndexRequest |
type(java.lang.String type)
Sets the type of the indexed document.
|
ActionRequestValidationException |
validate() |
long |
version()
Returns stored version.
|
IndexRequest |
version(long version)
Sets the version, which will cause the index operation to only be performed if a matching
version exists and no changes happened on the doc since then.
|
VersionType |
versionType() |
IndexRequest |
versionType(VersionType versionType)
Sets the versioning type.
|
void |
writeTo(StreamOutput out)
Write this object's fields to a StreamOutput.
|
getRefreshPolicy, setRefreshPolicy
createTask, getDescription, index, index, indices, indicesOptions, primaryTerm, primaryTerm, setShardId, shardId, timeout, timeout, timeout, waitForActiveShards, waitForActiveShards, waitForActiveShards
getShouldStoreResult
getParentTask, setParentTask, setParentTask
remoteAddress, remoteAddress
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
index, indicesOptions
indices
setRefreshPolicy
public static final int UNSET_AUTO_GENERATED_TIMESTAMP
getAutoGeneratedTimestamp()
if the document has an external
provided ID.public IndexRequest()
public IndexRequest(java.lang.String index)
type(String)
source(byte[])
must be set.public IndexRequest(java.lang.String index, java.lang.String type)
source(byte[])
must be set.public IndexRequest(java.lang.String index, java.lang.String type, java.lang.String id)
index
- The index to index intotype
- The type to index intoid
- The id of documentpublic ActionRequestValidationException validate()
validate
in interface WriteRequest<IndexRequest>
validate
in class ReplicationRequest<IndexRequest>
public XContentType getContentType()
public IndexRequest contentType(XContentType contentType)
public java.lang.String type()
type
in interface DocumentRequest<IndexRequest>
public IndexRequest type(java.lang.String type)
public java.lang.String id()
id
in interface DocumentRequest<IndexRequest>
public IndexRequest id(java.lang.String id)
public IndexRequest routing(java.lang.String routing)
routing
in interface DocumentRequest<IndexRequest>
public java.lang.String routing()
routing
in interface DocumentRequest<IndexRequest>
public IndexRequest parent(java.lang.String parent)
public java.lang.String parent()
DocumentRequest
parent
in interface DocumentRequest<IndexRequest>
@Deprecated public IndexRequest timestamp(java.lang.String timestamp)
@Deprecated public java.lang.String timestamp()
@Deprecated public IndexRequest ttl(java.lang.String ttl)
@Deprecated public IndexRequest ttl(TimeValue ttl)
TimeValue
instance.@Deprecated public IndexRequest ttl(long ttl)
public IndexRequest setPipeline(java.lang.String pipeline)
public java.lang.String getPipeline()
public BytesReference source()
public java.util.Map<java.lang.String,java.lang.Object> sourceAsMap()
public IndexRequest source(java.util.Map source) throws ElasticsearchGenerationException
Requests.INDEX_CONTENT_TYPE
.source
- The map to indexElasticsearchGenerationException
public IndexRequest source(java.util.Map source, XContentType contentType) throws ElasticsearchGenerationException
source
- The map to indexElasticsearchGenerationException
public IndexRequest source(java.lang.String source)
source(org.elasticsearch.common.xcontent.XContentBuilder)
or using the source(byte[])
.public IndexRequest source(XContentBuilder sourceBuilder)
public IndexRequest source(java.lang.Object... source)
Note: the number of objects passed to this method must be an even number. Also the first argument in each pair (the field name) must have a valid String representation.
public IndexRequest source(BytesReference source)
public IndexRequest source(byte[] source)
public IndexRequest source(byte[] source, int offset, int length)
source
- The source to indexoffset
- The offset in the byte arraylength
- The length of the datapublic IndexRequest opType(IndexRequest.OpType opType)
public IndexRequest opType(java.lang.String opType)
opType(org.elasticsearch.action.index.IndexRequest.OpType)
. Can
be either "index" or "create".public IndexRequest create(boolean create)
IndexRequest.OpType.CREATE
.public IndexRequest.OpType opType()
public IndexRequest version(long version)
public long version()
Versions.MATCH_ANY
and
opType is IndexRequest.OpType.CREATE
, returns Versions.MATCH_DELETED
.public IndexRequest versionType(VersionType versionType)
VersionType.INTERNAL
.public VersionType versionType()
public void process(@Nullable MappingMetaData mappingMd, boolean allowIdGeneration, java.lang.String concreteIndex)
public void resolveRouting(MetaData metaData)
public void readFrom(StreamInput in) throws java.io.IOException
Streamable
readFrom
in interface Streamable
readFrom
in class ReplicatedWriteRequest<IndexRequest>
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
Streamable
writeTo
in interface Streamable
writeTo
in class ReplicatedWriteRequest<IndexRequest>
java.io.IOException
public java.lang.String toString()
toString
in class ReplicationRequest<IndexRequest>
public boolean isRetry()
true
if this request has been sent to a shard copy more than once.public void onRetry()
ReplicationRequest
onRetry
in class ReplicationRequest<IndexRequest>
public long getAutoGeneratedTimestamp()