Package org.elasticsearch.client
Class NodesResponseHeader
java.lang.Object
org.elasticsearch.client.NodesResponseHeader
A utility class to parse the Nodes Header returned by
RestActions.buildNodesHeader(XContentBuilder, ToXContent.Params, BaseNodesResponse)
.-
Field Summary
Modifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ConstructingObjectParser<NodesResponseHeader,
Void> static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
-
Constructor Summary
ConstructorDescriptionNodesResponseHeader
(int total, int successful, int failed, List<ElasticsearchException> failures) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static NodesResponseHeader
fromXContent
(org.elasticsearch.xcontent.XContentParser parser, Void context) int
the number of nodes that the operation has failed onGet the failed node exceptions.int
the number of nodes that the operation was successful onint
getTotal()
the total number of nodes that the operation was carried onboolean
Determine if there are any node failures infailures
.int
hashCode()
-
Field Details
-
TOTAL
public static final org.elasticsearch.xcontent.ParseField TOTAL -
SUCCESSFUL
public static final org.elasticsearch.xcontent.ParseField SUCCESSFUL -
FAILED
public static final org.elasticsearch.xcontent.ParseField FAILED -
FAILURES
public static final org.elasticsearch.xcontent.ParseField FAILURES -
PARSER
public static final org.elasticsearch.xcontent.ConstructingObjectParser<NodesResponseHeader,Void> PARSER
-
-
Constructor Details
-
NodesResponseHeader
public NodesResponseHeader(int total, int successful, int failed, @Nullable List<ElasticsearchException> failures)
-
-
Method Details
-
fromXContent
public static NodesResponseHeader fromXContent(org.elasticsearch.xcontent.XContentParser parser, Void context) throws IOException - Throws:
IOException
-
getTotal
public int getTotal()the total number of nodes that the operation was carried on -
getFailed
public int getFailed()the number of nodes that the operation has failed on -
getSuccessful
public int getSuccessful()the number of nodes that the operation was successful on -
getFailures
Get the failed node exceptions.- Returns:
- Never
null
. Can be empty.
-
hasFailures
public boolean hasFailures()Determine if there are any node failures infailures
.- Returns:
true
iffailures
contains at least 1 exception.
-
equals
-
hashCode
public int hashCode()
-