Package org.elasticsearch.client.core

Class BroadcastResponse.Shards

java.lang.Object

org.elasticsearch.client.core.BroadcastResponse.Shards

Enclosing class:

BroadcastResponse

public static class BroadcastResponse.Shards
extends Object

Represents the results of a collection of shards on which a request was executed against.

Method Summary

Modifier and Type	Method	Description
int	failed()	The number of shards on which a request failed to be executed against.
Collection<DefaultShardOperationFailedException>	failures()	The failures corresponding to the shards on which a request failed to be executed against.
int	skipped()	The number of shards skipped by the request.
int	successful()	The number of successful shards on which a request was executed against.
int	total()	The total number of shards on which a request was executed against.

Methods inherited from class java.lang.Object

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

Method Details

total

public int total()

The total number of shards on which a request was executed against.

Returns:

the total number of shards

successful

public int successful()

The number of successful shards on which a request was executed against.

Returns:

the number of successful shards

skipped

public int skipped()

The number of shards skipped by the request.

Returns:

the number of skipped shards

failed

public int failed()

The number of shards on which a request failed to be executed against.

Returns:

the number of failed shards

failures

public Collection<DefaultShardOperationFailedException> failures()

The failures corresponding to the shards on which a request failed to be executed against. Note that the number of failures might not match failed() as some responses group together shard failures.

Returns:

the failures