Package org.elasticsearch.rest.action.document

Class RestBulkAction

java.lang.Object

org.elasticsearch.rest.BaseRestHandler

org.elasticsearch.rest.action.document.RestBulkAction

All Implemented Interfaces:

RestHandler

public class RestBulkAction
extends BaseRestHandler

 { "index" : { "_index" : "test", "_type" : "type1", "_id" : "1" }
 { "type1" : { "field1" : "value1" } }
 { "delete" : { "_index" : "test", "_type" : "type1", "_id" : "2" } }
 { "create" : { "_index" : "test", "_type" : "type1", "_id" : "1" }
 { "type1" : { "field1" : "value1" } }
 

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler

BaseRestHandler.RestChannelConsumer

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TYPES_DEPRECATION_MESSAGE

Fields inherited from class org.elasticsearch.rest.BaseRestHandler

DEFAULT_INCLUDE_TYPE_NAME_POLICY, INCLUDE_TYPE_NAME_PARAMETER, logger, MULTI_ALLOW_EXPLICIT_INDEX

Constructor Summary

Constructors

Constructor	Description
RestBulkAction(Settings settings, RestController controller)

Method Summary

Modifier and Type	Method	Description
boolean	allowsUnsafeBuffers()	Indicates if the RestHandler supports working with pooled buffers.
java.lang.String	getName()
BaseRestHandler.RestChannelConsumer	prepareRequest(RestRequest request, NodeClient client)	Prepare the request for execution.
boolean	supportsContentStream()	Indicates if the RestHandler supports content as a stream.

Methods inherited from class org.elasticsearch.rest.BaseRestHandler

getUsageCount, handleRequest, responseParams, unrecognized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.rest.RestHandler

canTripCircuitBreaker

Field Details

TYPES_DEPRECATION_MESSAGE

public static final java.lang.String TYPES_DEPRECATION_MESSAGE

See Also:

Constant Field Values

Constructor Details

RestBulkAction

public RestBulkAction(Settings settings, RestController controller)

Method Details

getName

public java.lang.String getName()

Specified by:

getName in class BaseRestHandler

Returns:

the name of this handler. The name should be human readable and should describe the action that will performed when this API is called. This name is used in the response to the RestNodesUsageAction.

prepareRequest

public BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws java.io.IOException

Description copied from class: BaseRestHandler

Prepare the request for execution. Implementations should consume all request params before returning the runnable for actual execution. Unconsumed params will immediately terminate execution of the request. However, some params are only used in processing the response; implementations can override BaseRestHandler.responseParams() to indicate such params.

Specified by:

prepareRequest in class BaseRestHandler

Parameters:

request - the request to execute

client - client for executing actions on the local node

Returns:

the action to execute

Throws:

java.io.IOException - if an I/O exception occurred parsing the request and preparing for execution

supportsContentStream

public boolean supportsContentStream()

Description copied from interface: RestHandler

Indicates if the RestHandler supports content as a stream. A stream would be multiple objects delineated by XContent.streamSeparator(). If a handler returns true this will affect the types of content that can be sent to this endpoint.

allowsUnsafeBuffers

public boolean allowsUnsafeBuffers()

Description copied from interface: RestHandler

Indicates if the RestHandler supports working with pooled buffers. If the request handler will not escape the return RestRequest.content() or any buffers extracted from it then there is no need to make a copies of any pooled buffers in the RestRequest instance before passing a request to this handler. If this instance does not support pooled/unsafe buffers RestRequest.ensureSafeBuffers() should be called on any request before passing it to RestHandler.handleRequest(org.elasticsearch.rest.RestRequest, org.elasticsearch.rest.RestChannel, org.elasticsearch.client.node.NodeClient).

Returns:

true iff the handler supports requests that make use of pooled buffers