Class DeleteByQueryResponse.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.core.DeleteByQueryResponse.Builder
- All Implemented Interfaces:
CopyableBuilder<DeleteByQueryResponse.Builder,,DeleteByQueryResponse> MutableBuilder<DeleteByQueryResponse.Builder,,DeleteByQueryResponse> ObjectBuilder<DeleteByQueryResponse>
- Enclosing class:
DeleteByQueryResponse
public static class DeleteByQueryResponse.Builder
extends ObjectBuilderBase
implements CopyableBuilder<DeleteByQueryResponse.Builder,DeleteByQueryResponse>
Builder for
DeleteByQueryResponse.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe number of scroll responses pulled back by the reindex operation.build()Builds aDeleteByQueryResponse.API name:canceledcopy()Create a new builderCopyableBuilderthat is a copy of this one.The number of documents that were successfully created.The number of documents that were successfully deleted.The list of failures that occurred during the operation.failures(List<BulkByScrollFailure> list) The list of failures that occurred during the operation.failures(BulkByScrollFailure value, BulkByScrollFailure... values) The list of failures that occurred during the operation.The number of documents that were ignored.requestsPerSecond(Float value) The number of requests per second effectively executed during the reindex operation.API name:retriesAPI name:retriesAPI name:slice_idslices(Function<BulkByScrollTaskStatusOrException.Builder, ObjectBuilder<BulkByScrollTaskStatusOrException>> fn) API name:slicesAPI name:slicesslices(BulkByScrollTaskStatusOrException value, BulkByScrollTaskStatusOrException... values) API name:slicesAPI name:taskAPI name:throttledAPI name:throttledthrottledMillis(Long value) API name:throttled_millisThe amount time before the throttling will end.throttledUntil(Time value) The amount time before the throttling will end.throttledUntilMillis(Long value) When the throttling will end in milliseconds.Whether the operation timed out.The time taken by the operation in milliseconds.The number of documents that were successfully processed.The number of documents that were successfully updated after the reindex operation.versionConflicts(Long value) The number of version conflicts encountered by the reindex operation.Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<DeleteByQueryResponse.Builder,DeleteByQueryResponse> - Returns:
- a new builder instance.
-
batches
The number of scroll responses pulled back by the reindex operation.API name:
batches -
canceled
API name:canceled -
created
The number of documents that were successfully created.API name:
created -
deleted
The number of documents that were successfully deleted.API name:
deleted -
failures
The list of failures that occurred during the operation.API name:
failuresAdds all elements of
listtofailures. -
failures
@Nonnull public final DeleteByQueryResponse.Builder failures(BulkByScrollFailure value, BulkByScrollFailure... values) The list of failures that occurred during the operation.API name:
failuresAdds one or more values to
failures. -
failures
@Nonnull public final DeleteByQueryResponse.Builder failures(Function<BulkByScrollFailure.Builder, ObjectBuilder<BulkByScrollFailure>> fn) The list of failures that occurred during the operation.API name:
failuresAdds a value to
failuresusing a builder lambda. -
noops
The number of documents that were ignored.API name:
noops -
requestsPerSecond
The number of requests per second effectively executed during the reindex operation.API name:
requests_per_second -
retries
API name:retries -
retries
@Nonnull public final DeleteByQueryResponse.Builder retries(Function<Retries.Builder, ObjectBuilder<Retries>> fn) API name:retries -
sliceId
API name:slice_id -
slices
@Nonnull public final DeleteByQueryResponse.Builder slices(List<BulkByScrollTaskStatusOrException> list) API name:slicesAdds all elements of
listtoslices. -
slices
@Nonnull public final DeleteByQueryResponse.Builder slices(BulkByScrollTaskStatusOrException value, BulkByScrollTaskStatusOrException... values) API name:slicesAdds one or more values to
slices. -
slices
@Nonnull public final DeleteByQueryResponse.Builder slices(Function<BulkByScrollTaskStatusOrException.Builder, ObjectBuilder<BulkByScrollTaskStatusOrException>> fn) API name:slicesAdds a value to
slicesusing a builder lambda. -
task
API name:task -
throttled
API name:throttled -
throttled
@Nonnull public final DeleteByQueryResponse.Builder throttled(Function<Time.Builder, ObjectBuilder<Time>> fn) API name:throttled -
throttledMillis
API name:throttled_millis -
throttledUntil
The amount time before the throttling will end.API name:
throttled_until -
throttledUntil
@Nonnull public final DeleteByQueryResponse.Builder throttledUntil(Function<Time.Builder, ObjectBuilder<Time>> fn) The amount time before the throttling will end.API name:
throttled_until -
throttledUntilMillis
When the throttling will end in milliseconds.API name:
throttled_until_millis -
timedOut
Whether the operation timed out.API name:
timed_out -
took
The time taken by the operation in milliseconds.API name:
took -
total
The number of documents that were successfully processed.API name:
total -
updated
The number of documents that were successfully updated after the reindex operation.API name:
updated -
versionConflicts
The number of version conflicts encountered by the reindex operation.API name:
version_conflicts -
build
Builds aDeleteByQueryResponse.- Specified by:
buildin interfaceObjectBuilder<DeleteByQueryResponse>- Throws:
NullPointerException- if some of the required fields are null.
-