Module org.elasticsearch.server

Package org.elasticsearch.rest.action

Class RestActions

java.lang.Object

org.elasticsearch.rest.action.RestActions

public class RestActions
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RestActions.NodesResponseRestListener<NodesResponse extends BaseNodesResponse<?> & ToXContent>	NodesResponseRestBuilderListener automatically translates any BaseNodesResponse (multi-node) response that is ToXContent-compatible into a RestResponse with the necessary header info (e.g., "cluster_name").

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	_SHARDS_FIELD
static final ParseField	FAILED_FIELD
static final ParseField	FAILURES_FIELD
static final ParseField	SKIPPED_FIELD
static final ParseField	SUCCESSFUL_FIELD
static final ParseField	TOTAL_FIELD

Constructor Summary

Constructors

Constructor	Description
RestActions()

Method Summary

Modifier and Type	Method	Description
static void	buildBroadcastShardsHeader(XContentBuilder builder, ToXContent.Params params, int total, int successful, int skipped, int failed, ShardOperationFailedException[] shardFailures)
static void	buildBroadcastShardsHeader(XContentBuilder builder, ToXContent.Params params, BroadcastResponse response)
static void	buildNodesHeader(XContentBuilder builder, ToXContent.Params params, int total, int successful, int failed, List<FailedNodeException> failures)	Create the XContent header for any BaseNodesResponse.
static <NodeResponse extends BaseNodeResponse> void	buildNodesHeader(XContentBuilder builder, ToXContent.Params params, BaseNodesResponse<NodeResponse> response)	Create the XContent header for any BaseNodesResponse.
static QueryBuilder	getQueryContent(String fieldName, XContentParser requestParser)
static QueryBuilder	getQueryContent(XContentParser requestParser)
static <NodesResponse extends BaseNodesResponse & ToXContent> RestResponse	nodesResponse(XContentBuilder builder, ToXContent.Params params, NodesResponse response)	Automatically transform the ToXContent-compatible, nodes-level response into a a RestResponse.
static long	parseVersion(RestRequest request)
static long	parseVersion(RestRequest request, long defaultVersion)
static QueryBuilder	urlParamsToQueryBuilder(RestRequest request)

Methods inherited from class java.lang.Object

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

Field Details

_SHARDS_FIELD

public static final ParseField _SHARDS_FIELD

TOTAL_FIELD

public static final ParseField TOTAL_FIELD

SUCCESSFUL_FIELD

public static final ParseField SUCCESSFUL_FIELD

SKIPPED_FIELD

public static final ParseField SKIPPED_FIELD

FAILED_FIELD

public static final ParseField FAILED_FIELD

FAILURES_FIELD

public static final ParseField FAILURES_FIELD

Constructor Details

RestActions

public RestActions()

Method Details

parseVersion

public static long parseVersion(RestRequest request)

parseVersion

public static long parseVersion(RestRequest request,
 long defaultVersion)

buildBroadcastShardsHeader

public static void buildBroadcastShardsHeader(XContentBuilder builder,
 ToXContent.Params params,
 BroadcastResponse response)
                                       throws IOException

Throws:

IOException

buildBroadcastShardsHeader

public static void buildBroadcastShardsHeader(XContentBuilder builder,
 ToXContent.Params params,
 int total,
 int successful,
 int skipped,
 int failed,
 ShardOperationFailedException[] shardFailures)
                                       throws IOException

Throws:

IOException

buildNodesHeader

public static <NodeResponse extends BaseNodeResponse>
void buildNodesHeader(XContentBuilder builder,
 ToXContent.Params params,
 BaseNodesResponse<NodeResponse> response)
               throws IOException

Create the XContent header for any BaseNodesResponse.

Parameters:

builder - XContent builder.

params - XContent parameters.

response - The response containing individual, node-level responses.

Throws:

IOException

See Also:

• buildNodesHeader(XContentBuilder, Params, int, int, int, List)

buildNodesHeader

public static void buildNodesHeader(XContentBuilder builder,
 ToXContent.Params params,
 int total,
 int successful,
 int failed,
 List<FailedNodeException> failures)
                             throws IOException

Create the XContent header for any BaseNodesResponse. This looks like: "_nodes" : { "total" : 3, "successful" : 1, "failed" : 2, "failures" : [ { ... }, { ... } ] } Prefer the overload that properly invokes this method to calling this directly.

Parameters:

builder - XContent builder.

params - XContent parameters.

total - The total number of nodes touched.

successful - The successful number of responses received.

failed - The number of failures (effectively total - successful).

failures - The failure exceptions related to failed.

Throws:

IOException

See Also:

• buildNodesHeader(XContentBuilder, Params, BaseNodesResponse)

nodesResponse

public static <NodesResponse extends BaseNodesResponse & ToXContent>
RestResponse nodesResponse(XContentBuilder builder,
 ToXContent.Params params,
 NodesResponse response)
                    throws IOException

Automatically transform the ToXContent-compatible, nodes-level response into a a RestResponse.

This looks like: { "_nodes" : { ... }, "cluster_name" : "...", ... }

Parameters:

builder - XContent builder.

params - XContent parameters.

response - The nodes-level (plural) response.

Returns:

Never null.

Throws:

IOException - if building the response causes an issue

urlParamsToQueryBuilder

public static QueryBuilder urlParamsToQueryBuilder(RestRequest request)

getQueryContent

public static QueryBuilder getQueryContent(XContentParser requestParser)

getQueryContent

public static QueryBuilder getQueryContent(String fieldName,
 XContentParser requestParser)