WriteRequestBuilder<UpdateRequestBuilder>
public class UpdateRequestBuilder extends InstanceShardOperationRequestBuilder<UpdateRequest,UpdateResponse,UpdateRequestBuilder> implements WriteRequestBuilder<UpdateRequestBuilder>
action, client, request
Constructor | Description |
---|---|
UpdateRequestBuilder(ElasticsearchClient client,
UpdateAction action) |
|
UpdateRequestBuilder(ElasticsearchClient client,
UpdateAction action,
java.lang.String index,
java.lang.String type,
java.lang.String id) |
Modifier and Type | Method | Description |
---|---|---|
UpdateRequestBuilder |
setDetectNoop(boolean detectNoop) |
Sets whether to perform extra effort to detect noop updates via docAsUpsert.
|
UpdateRequestBuilder |
setDoc(byte[] source,
int offset,
int length,
XContentType xContentType) |
Sets the doc to use for updates when a script is not specified.
|
UpdateRequestBuilder |
setDoc(byte[] source,
XContentType xContentType) |
Sets the doc to use for updates when a script is not specified.
|
UpdateRequestBuilder |
setDoc(java.lang.Object... source) |
Sets the doc to use for updates when a script is not specified, the doc provided
is a field and value pairs.
|
UpdateRequestBuilder |
setDoc(java.lang.String source,
XContentType xContentType) |
Sets the doc to use for updates when a script is not specified.
|
UpdateRequestBuilder |
setDoc(java.util.Map source) |
Sets the doc to use for updates when a script is not specified.
|
UpdateRequestBuilder |
setDoc(java.util.Map source,
XContentType contentType) |
Sets the doc to use for updates when a script is not specified.
|
UpdateRequestBuilder |
setDoc(IndexRequest indexRequest) |
Sets the doc to use for updates when a script is not specified.
|
UpdateRequestBuilder |
setDoc(XContentBuilder source) |
Sets the doc to use for updates when a script is not specified.
|
UpdateRequestBuilder |
setDoc(XContentType xContentType,
java.lang.Object... source) |
Sets the doc to use for updates when a script is not specified, the doc provided
is a field and value pairs.
|
UpdateRequestBuilder |
setDocAsUpsert(boolean shouldUpsertDoc) |
Sets whether the specified doc parameter should be used as upsert document.
|
UpdateRequestBuilder |
setFetchSource(boolean fetchSource) |
Indicates whether the response should contain the updated _source.
|
UpdateRequestBuilder |
setFetchSource(java.lang.String[] includes,
java.lang.String[] excludes) |
Indicate that _source should be returned, with an
"include" and/or "exclude" set which can include simple wildcard
elements.
|
UpdateRequestBuilder |
setFetchSource(java.lang.String include,
java.lang.String exclude) |
Indicate that _source should be returned with every hit, with an
"include" and/or "exclude" set which can include simple wildcard
elements.
|
UpdateRequestBuilder |
setFields(java.lang.String... fields) |
Deprecated.
Use
setFetchSource(String[], String[]) instead |
UpdateRequestBuilder |
setId(java.lang.String id) |
Sets the id of the indexed document.
|
UpdateRequestBuilder |
setParent(java.lang.String parent) |
|
UpdateRequestBuilder |
setRetryOnConflict(int retryOnConflict) |
Sets the number of retries of a version conflict occurs because the document was updated between
getting it and updating it.
|
UpdateRequestBuilder |
setRouting(java.lang.String routing) |
Controls the shard routing of the request.
|
UpdateRequestBuilder |
setScript(Script script) |
The script to execute.
|
UpdateRequestBuilder |
setScriptedUpsert(boolean scriptedUpsert) |
Sets whether the script should be run in the case of an insert
|
UpdateRequestBuilder |
setType(java.lang.String type) |
Sets the type of the indexed document.
|
UpdateRequestBuilder |
setUpsert(byte[] source,
int offset,
int length,
XContentType xContentType) |
Sets the doc source of the update request to be used when the document does not exists.
|
UpdateRequestBuilder |
setUpsert(byte[] source,
XContentType xContentType) |
Sets the doc source of the update request to be used when the document does not exists.
|
UpdateRequestBuilder |
setUpsert(java.lang.Object... source) |
Sets the doc source of the update request to be used when the document does not exists.
|
UpdateRequestBuilder |
setUpsert(java.lang.String source,
XContentType xContentType) |
Sets the doc source of the update request to be used when the document does not exists.
|
UpdateRequestBuilder |
setUpsert(java.util.Map source) |
Sets the doc source of the update request to be used when the document does not exists.
|
UpdateRequestBuilder |
setUpsert(java.util.Map source,
XContentType contentType) |
Sets the doc source of the update request to be used when the document does not exists.
|
UpdateRequestBuilder |
setUpsert(IndexRequest indexRequest) |
Sets the index request to be used if the document does not exists.
|
UpdateRequestBuilder |
setUpsert(XContentBuilder source) |
Sets the doc source of the update request to be used when the document does not exists.
|
UpdateRequestBuilder |
setUpsert(XContentType xContentType,
java.lang.Object... source) |
Sets the doc source of the update request to be used when the document does not exists.
|
UpdateRequestBuilder |
setVersion(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.
|
UpdateRequestBuilder |
setVersionType(VersionType versionType) |
Sets the versioning type.
|
UpdateRequestBuilder |
setWaitForActiveShards(int waitForActiveShards) |
A shortcut for
setWaitForActiveShards(ActiveShardCount) where the numerical
shard count is passed in, instead of having to first call ActiveShardCount.from(int)
to get the ActiveShardCount. |
UpdateRequestBuilder |
setWaitForActiveShards(ActiveShardCount waitForActiveShards) |
Sets the number of shard copies that must be active before proceeding with the write.
|
execute, execute, get, get, get, request
setIndex, setTimeout, setTimeout
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
request, setRefreshPolicy, setRefreshPolicy
public UpdateRequestBuilder(ElasticsearchClient client, UpdateAction action)
public UpdateRequestBuilder(ElasticsearchClient client, UpdateAction action, java.lang.String index, java.lang.String type, java.lang.String id)
public UpdateRequestBuilder setType(java.lang.String type)
public UpdateRequestBuilder setId(java.lang.String id)
public UpdateRequestBuilder setRouting(java.lang.String routing)
public UpdateRequestBuilder setParent(java.lang.String parent)
public UpdateRequestBuilder setScript(Script script)
The script works with the variable ctx
, which is bound to the entry,
e.g. ctx._source.mycounter += 1
.
@Deprecated public UpdateRequestBuilder setFields(java.lang.String... fields)
setFetchSource(String[], String[])
insteadpublic UpdateRequestBuilder setFetchSource(@Nullable java.lang.String include, @Nullable java.lang.String exclude)
include
- An optional include (optionally wildcarded) pattern to filter
the returned _sourceexclude
- An optional exclude (optionally wildcarded) pattern to filter
the returned _sourcepublic UpdateRequestBuilder setFetchSource(@Nullable java.lang.String[] includes, @Nullable java.lang.String[] excludes)
includes
- An optional list of include (optionally wildcarded) pattern to
filter the returned _sourceexcludes
- An optional list of exclude (optionally wildcarded) pattern to
filter the returned _sourcepublic UpdateRequestBuilder setFetchSource(boolean fetchSource)
public UpdateRequestBuilder setRetryOnConflict(int retryOnConflict)
public UpdateRequestBuilder setVersion(long version)
public UpdateRequestBuilder setVersionType(VersionType versionType)
VersionType.INTERNAL
.public UpdateRequestBuilder setWaitForActiveShards(ActiveShardCount waitForActiveShards)
ReplicationRequest.waitForActiveShards(ActiveShardCount)
for details.public UpdateRequestBuilder setWaitForActiveShards(int waitForActiveShards)
setWaitForActiveShards(ActiveShardCount)
where the numerical
shard count is passed in, instead of having to first call ActiveShardCount.from(int)
to get the ActiveShardCount.public UpdateRequestBuilder setDoc(IndexRequest indexRequest)
public UpdateRequestBuilder setDoc(XContentBuilder source)
public UpdateRequestBuilder setDoc(java.util.Map source)
public UpdateRequestBuilder setDoc(java.util.Map source, XContentType contentType)
public UpdateRequestBuilder setDoc(java.lang.String source, XContentType xContentType)
public UpdateRequestBuilder setDoc(byte[] source, XContentType xContentType)
public UpdateRequestBuilder setDoc(byte[] source, int offset, int length, XContentType xContentType)
public UpdateRequestBuilder setDoc(java.lang.Object... source)
public UpdateRequestBuilder setDoc(XContentType xContentType, java.lang.Object... source)
public UpdateRequestBuilder setUpsert(IndexRequest indexRequest)
DocumentMissingException
is thrown.public UpdateRequestBuilder setUpsert(XContentBuilder source)
public UpdateRequestBuilder setUpsert(java.util.Map source)
public UpdateRequestBuilder setUpsert(java.util.Map source, XContentType contentType)
public UpdateRequestBuilder setUpsert(java.lang.String source, XContentType xContentType)
public UpdateRequestBuilder setUpsert(byte[] source, XContentType xContentType)
public UpdateRequestBuilder setUpsert(byte[] source, int offset, int length, XContentType xContentType)
public UpdateRequestBuilder setUpsert(java.lang.Object... source)
public UpdateRequestBuilder setUpsert(XContentType xContentType, java.lang.Object... source)
public UpdateRequestBuilder setDocAsUpsert(boolean shouldUpsertDoc)
public UpdateRequestBuilder setDetectNoop(boolean detectNoop)
public UpdateRequestBuilder setScriptedUpsert(boolean scriptedUpsert)