Documentation for bulk errors.

Original Pull Request spring-projects#1982 
Closes spring-projects#1981

Author: sothawo

Diff for: src/main/java/org/springframework/data/elasticsearch/core/DocumentOperations.java

@@ -164,6 +164,7 @@ public interface DocumentOperations {
 	 * @param queries the queries to execute in bulk
 	 * @param clazz the entity class
 	 * @return the information about the indexed objects
+	 * @throws org.springframework.data.elasticsearch.BulkFailureException with information about the failed operation
 	 * @since 4.1
 	 */
 	default List<IndexedObjectInformation> bulkIndex(List<IndexQuery> queries, Class<?> clazz) {
@@ -175,6 +176,7 @@ default List<IndexedObjectInformation> bulkIndex(List<IndexQuery> queries, Class
 	 *
 	 * @param queries the queries to execute in bulk
 	 * @return the information about of the indexed objects
+	 * @throws org.springframework.data.elasticsearch.BulkFailureException with information about the failed operation
 	 */
 	default List<IndexedObjectInformation> bulkIndex(List<IndexQuery> queries, IndexCoordinates index) {
 		return bulkIndex(queries, BulkOptions.defaultOptions(), index);
@@ -187,6 +189,7 @@ default List<IndexedObjectInformation> bulkIndex(List<IndexQuery> queries, Index
 	 * @param bulkOptions options to be added to the bulk request
 	 * @param clazz the entity class
 	 * @return the information about of the indexed objects
+	 * @throws org.springframework.data.elasticsearch.BulkFailureException with information about the failed operation
 	 * @since 4.1
 	 */
 	List<IndexedObjectInformation> bulkIndex(List<IndexQuery> queries, BulkOptions bulkOptions, Class<?> clazz);
@@ -197,13 +200,15 @@ default List<IndexedObjectInformation> bulkIndex(List<IndexQuery> queries, Index
 	 * @param queries the queries to execute in bulk
 	 * @param bulkOptions options to be added to the bulk request
 	 * @return the information about of the indexed objects
+	 * @throws org.springframework.data.elasticsearch.BulkFailureException with information about the failed operation
 	 */
 	List<IndexedObjectInformation> bulkIndex(List<IndexQuery> queries, BulkOptions bulkOptions, IndexCoordinates index);
 
 	/**
 	 * Bulk update all objects. Will do update.
 	 *
 	 * @param queries the queries to execute in bulk
+	 * @throws org.springframework.data.elasticsearch.BulkFailureException with information about the failed operation
 	 */
 	default void bulkUpdate(List<UpdateQuery> queries, IndexCoordinates index) {
 		bulkUpdate(queries, BulkOptions.defaultOptions(), index);
@@ -214,6 +219,7 @@ default void bulkUpdate(List<UpdateQuery> queries, IndexCoordinates index) {
 	 *
 	 * @param clazz the entity class
 	 * @param queries the queries to execute in bulk
+	 * @throws org.springframework.data.elasticsearch.BulkFailureException with information about the failed operation
 	 * @since 4.1
 	 */
 	void bulkUpdate(List<UpdateQuery> queries, Class<?> clazz);
@@ -223,6 +229,7 @@ default void bulkUpdate(List<UpdateQuery> queries, IndexCoordinates index) {
 	 *
 	 * @param queries the queries to execute in bulk
 	 * @param bulkOptions options to be added to the bulk request
+	 * @throws org.springframework.data.elasticsearch.BulkFailureException with information about the failed operation
 	 */
 	void bulkUpdate(List<UpdateQuery> queries, BulkOptions bulkOptions, IndexCoordinates index);
 

Diff for: src/main/java/org/springframework/data/elasticsearch/core/ReactiveDocumentOperations.java

@@ -106,7 +106,8 @@ default <T> Flux<T> saveAll(Iterable<T> entities, Class<T> clazz) {
 
 	/**
 	 * Index entities in the given {@literal index}. If the {@literal index} is {@literal null} or empty the index name
-	 * provided via entity metadata is used.
+	 * provided via entity metadata is used. On errors returns with
+	 * {@link org.springframework.data.elasticsearch.BulkFailureException} with information about the failed operation
 	 *
 	 * @param entities must not be {@literal null}.
 	 * @param index the target index, must not be {@literal null}
@@ -168,7 +169,8 @@ default <T> Flux<T> saveAll(Iterable<T> entities, IndexCoordinates index) {
 	<T> Flux<MultiGetItem<T>> multiGet(Query query, Class<T> clazz, IndexCoordinates index);
 
 	/**
-	 * Bulk update all objects. Will do update.
+	 * Bulk update all objects. Will do update. On errors returns with
+	 * {@link org.springframework.data.elasticsearch.BulkFailureException} with information about the failed operation
 	 *
 	 * @param queries the queries to execute in bulk
 	 * @since 4.0
@@ -182,6 +184,7 @@ default Mono<Void> bulkUpdate(List<UpdateQuery> queries, IndexCoordinates index)
 	 *
 	 * @param queries the queries to execute in bulk
 	 * @param bulkOptions options to be added to the bulk request
+	 * @throws org.springframework.data.elasticsearch.BulkFailureException with information about the failed operation
 	 * @since 4.0
 	 */
 	Mono<Void> bulkUpdate(List<UpdateQuery> queries, BulkOptions bulkOptions, IndexCoordinates index);