Package org.springframework.data.elasticsearch.core.query

Class BulkOptions

java.lang.Object

org.springframework.data.elasticsearch.core.query.BulkOptions

public class BulkOptions
extends Object

Options that may be passed to an DocumentOperations.bulkIndex(List, BulkOptions, IndexCoordinates) or DocumentOperations.bulkUpdate(List, BulkOptions, IndexCoordinates) call.
Use builder() to obtain a builder, then set the desired properties and call BulkOptions.BulkOptionsBuilder.build() to get the BulkOptions object.

Since:

3.2

Author:

Peter-Josef Meisch, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BulkOptions.BulkOptionsBuilder	Builder for BulkOptions.

Method Summary

Modifier and Type	Method	Description
static BulkOptions.BulkOptionsBuilder	builder()	Create a new BulkOptions.BulkOptionsBuilder to build BulkOptions.
static BulkOptions	defaultOptions()	Return default BulkOptions.
String	getPipeline()
RefreshPolicy	getRefreshPolicy()
String	getRoutingId()
Duration	getTimeout()
ActiveShardCount	getWaitForActiveShards()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getTimeout

@Nullable
public Duration getTimeout()

getRefreshPolicy

@Nullable
public RefreshPolicy getRefreshPolicy()

getWaitForActiveShards

@Nullable
public ActiveShardCount getWaitForActiveShards()

getPipeline

@Nullable
public String getPipeline()

getRoutingId

@Nullable
public String getRoutingId()

builder

public static BulkOptions.BulkOptionsBuilder builder()

Create a new BulkOptions.BulkOptionsBuilder to build BulkOptions.

Returns:

a new BulkOptions.BulkOptionsBuilder to build BulkOptions.

defaultOptions

public static BulkOptions defaultOptions()

Return default BulkOptions.

Returns:

default BulkOptions.