java.lang.Object
- org.opensearch.client.opensearch._types.RequestBase
- - org.opensearch.client.opensearch.core.BulkRequest

All Implemented Interfaces:

JsonpSerializable, NdJsonpSerializable
```
public class BulkRequest
extends RequestBase
implements NdJsonpSerializable, JsonpSerializable
```
Allows to perform multiple index/update/delete operations in a single request.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class BulkRequest.Builder
Builder for BulkRequest.
- Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
  RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields
Modifier and Type Field Description

static Endpoint<BulkRequest,BulkResponse,ErrorResponse> _ENDPOINT
Endpoint "bulk".

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.Iterator<?>`	`_serializables()`
`java.lang.String`	`index()`	Default index for items which don't provide one
`static BulkRequest`	`of(java.util.function.Function<BulkRequest.Builder,ObjectBuilder<BulkRequest>> fn)`
`java.util.List<BulkOperation>`	`operations()`	Required - Request body.
`java.lang.String`	`pipeline()`	The pipeline id to preprocess incoming documents with
`Refresh`	`refresh()`	If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
`java.lang.Boolean`	`requireAlias()`	Sets require_alias for all incoming documents.
`java.lang.String`	`routing()`	Specific routing value
`void`	`serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`	Serialize this value to JSON.
`SourceConfigParam`	`source()`	True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
`java.util.List<java.lang.String>`	`sourceExcludes()`	Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
`java.util.List<java.lang.String>`	`sourceIncludes()`	Default list of fields to extract and return from the _source field, can be overridden on each sub-request
`Time`	`timeout()`	Explicit operation timeout
`WaitForActiveShards`	`waitForActiveShards()`	Sets the number of shard copies that must be active before proceeding with the bulk operation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _ENDPOINT
```
public static final Endpoint<BulkRequest,BulkResponse,ErrorResponse> _ENDPOINT
```
    Endpoint "bulk".
- Method Detail
  - of
```
public static BulkRequest of(java.util.function.Function<BulkRequest.Builder,ObjectBuilder<BulkRequest>> fn)
```
  - _serializables
```
public java.util.Iterator<?> _serializables()
```
    Specified by:
    
    _serializables in interface NdJsonpSerializable
  - source
```
@Nullable
public final SourceConfigParam source()
```
    True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
    API name: _source
  - sourceExcludes
```
public final java.util.List<java.lang.String> sourceExcludes()
```
    Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
    API name: _source_excludes
  - sourceIncludes
```
public final java.util.List<java.lang.String> sourceIncludes()
```
    Default list of fields to extract and return from the _source field, can be overridden on each sub-request
    API name: _source_includes
  - index
```
@Nullable
public final java.lang.String index()
```
    Default index for items which don't provide one
    API name: index
  - pipeline
```
@Nullable
public final java.lang.String pipeline()
```
    The pipeline id to preprocess incoming documents with
    API name: pipeline
  - refresh
```
@Nullable
public final Refresh refresh()
```
    If true then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false (the default) then do nothing with refreshes.
    API name: refresh
  - requireAlias
```
@Nullable
public final java.lang.Boolean requireAlias()
```
    Sets require_alias for all incoming documents. Defaults to unset (false)
    API name: require_alias
  - routing
```
@Nullable
public final java.lang.String routing()
```
    Specific routing value
    API name: routing
  - timeout
```
@Nullable
public final Time timeout()
```
    Explicit operation timeout
    API name: timeout
  - waitForActiveShards
```
@Nullable
public final WaitForActiveShards waitForActiveShards()
```
    Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to all for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
    API name: wait_for_active_shards
  - operations
```
public final java.util.List<BulkOperation> operations()
```
    Required - Request body.
    API name: _value_body
  - serialize
```
public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)
```
    Serialize this value to JSON.
    
    Specified by:
    
    serialize in interface JsonpSerializable

Class BulkRequest

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_ENDPOINT

Method Detail

of

_serializables

source

sourceExcludes

sourceIncludes

index

pipeline

refresh

requireAlias

routing

timeout

waitForActiveShards

operations

serialize