Package org.elasticsearch.client
Class NodesResponseHeader
java.lang.Object
org.elasticsearch.client.NodesResponseHeader
public final class NodesResponseHeader
extends java.lang.Object
A utility class to parse the Nodes Header returned by
RestActions.buildNodesHeader(XContentBuilder, ToXContent.Params, BaseNodesResponse)
.-
Field Summary
Fields Modifier and Type Field Description static org.elasticsearch.common.ParseField
FAILED
static org.elasticsearch.common.ParseField
FAILURES
static org.elasticsearch.common.xcontent.ConstructingObjectParser<NodesResponseHeader,java.lang.Void>
PARSER
static org.elasticsearch.common.ParseField
SUCCESSFUL
static org.elasticsearch.common.ParseField
TOTAL
-
Constructor Summary
Constructors Constructor Description NodesResponseHeader(int total, int successful, int failed, java.util.List<org.elasticsearch.ElasticsearchException> failures)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object o)
static NodesResponseHeader
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser, java.lang.Void context)
int
getFailed()
the number of nodes that the operation has failed onjava.util.List<org.elasticsearch.ElasticsearchException>
getFailures()
Get the failed node exceptions.int
getSuccessful()
the number of nodes that the operation was successful onint
getTotal()
the total number of nodes that the operation was carried onboolean
hasFailures()
Determine if there are any node failures infailures
.int
hashCode()
-
Field Details
-
TOTAL
public static final org.elasticsearch.common.ParseField TOTAL -
SUCCESSFUL
public static final org.elasticsearch.common.ParseField SUCCESSFUL -
FAILED
public static final org.elasticsearch.common.ParseField FAILED -
FAILURES
public static final org.elasticsearch.common.ParseField FAILURES -
PARSER
public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<NodesResponseHeader,java.lang.Void> PARSER
-
-
Constructor Details
-
NodesResponseHeader
public NodesResponseHeader(int total, int successful, int failed, @Nullable java.util.List<org.elasticsearch.ElasticsearchException> failures)
-
-
Method Details
-
fromXContent
public static NodesResponseHeader fromXContent(org.elasticsearch.common.xcontent.XContentParser parser, java.lang.Void context) throws java.io.IOException- Throws:
java.io.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
public java.util.List<org.elasticsearch.ElasticsearchException> 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
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-