Package org.elasticsearch.rest.action
Class RestActions
java.lang.Object
org.elasticsearch.rest.action.RestActions
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
NodesResponseRestBuilderListener
automatically translates anyBaseNodesResponse
(multi-node) response that isToXContent
-compatible into aRestResponse
with the necessary header info (e.g., "cluster_name"). -
Field Summary
Modifier and TypeFieldDescriptionstatic final ParseField
static final ParseField
static final ParseField
static final ParseField
static final ParseField
static final ParseField
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic 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 anyBaseNodesResponse
.static <NodeResponse extends BaseNodeResponse>
voidbuildNodesHeader
(XContentBuilder builder, ToXContent.Params params, BaseNodesResponse<NodeResponse> response) Create the XContent header for anyBaseNodesResponse
.static QueryBuilder
getQueryContent
(String fieldName, XContentParser requestParser) static QueryBuilder
getQueryContent
(XContentParser requestParser) static <NodesResponse extends BaseNodesResponse & ToXContent>
BytesRestResponsenodesResponse
(XContentBuilder builder, ToXContent.Params params, NodesResponse response) static long
parseVersion
(RestRequest request) static long
parseVersion
(RestRequest request, long defaultVersion) static QueryBuilder
urlParamsToQueryBuilder
(RestRequest request)
-
Field Details
-
_SHARDS_FIELD
-
TOTAL_FIELD
-
SUCCESSFUL_FIELD
-
SKIPPED_FIELD
-
FAILED_FIELD
-
FAILURES_FIELD
-
-
Constructor Details
-
RestActions
public RestActions()
-
-
Method Details
-
parseVersion
-
parseVersion
-
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 anyBaseNodesResponse
.- Parameters:
builder
- XContent builder.params
- XContent parameters.response
- The response containing individual, node-level responses.- Throws:
IOException
- See Also:
-
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 anyBaseNodesResponse
. 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 (effectivelytotal - successful
).failures
- The failure exceptions related tofailed
.- Throws:
IOException
- See Also:
-
nodesResponse
public static <NodesResponse extends BaseNodesResponse & ToXContent> BytesRestResponse nodesResponse(XContentBuilder builder, ToXContent.Params params, NodesResponse response) throws IOException Automatically transform theToXContent
-compatible, nodes-levelresponse
into a aBytesRestResponse
.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
-
getQueryContent
-
getQueryContent
-