org.elasticsearch.indices.flush

Class ShardsSyncedFlushResult

java.lang.Object

org.elasticsearch.indices.flush.ShardsSyncedFlushResult

All Implemented Interfaces:

Streamable

public class ShardsSyncedFlushResult
extends Object
implements Streamable

Result for all copies of a shard

Constructor Summary

Constructors

Constructor and Description
ShardsSyncedFlushResult(ShardId shardId, int totalShards, String failureReason) failure constructor
ShardsSyncedFlushResult(ShardId shardId, String syncId, int totalShards, Map<ShardRouting,SyncedFlushService.ShardSyncedFlushResponse> shardResponses) success constructor

Method Summary

Modifier and Type	Method and Description
boolean	failed()
Map<ShardRouting,SyncedFlushService.ShardSyncedFlushResponse>	failedShards()
String	failureReason()
ShardId	getShardId()
void	readFrom(StreamInput in)
static ShardsSyncedFlushResult	readShardsSyncedFlushResult(StreamInput in)
ShardId	shardId()
Map<ShardRouting,SyncedFlushService.ShardSyncedFlushResponse>	shardResponses()
int	successfulShards()
String	syncId()
int	totalShards()
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

ShardsSyncedFlushResult

public ShardsSyncedFlushResult(ShardId shardId,
                               int totalShards,
                               String failureReason)

failure constructor

ShardsSyncedFlushResult

public ShardsSyncedFlushResult(ShardId shardId,
                               String syncId,
                               int totalShards,
                               Map<ShardRouting,SyncedFlushService.ShardSyncedFlushResponse> shardResponses)

success constructor

Method Detail

getShardId

public ShardId getShardId()

failed

public boolean failed()

Returns:

true if the operation failed before reaching step three of synced flush. failureReason() can be used for more details

failureReason

public String failureReason()

Returns:

the reason for the failure if synced flush failed before step three of synced flush

syncId

public String syncId()

totalShards

public int totalShards()

Returns:

total number of shards for which a sync attempt was made

successfulShards

public int successfulShards()

Returns:

total number of successful shards

failedShards

public Map<ShardRouting,SyncedFlushService.ShardSyncedFlushResponse> failedShards()

Returns:

an array of shard failures

shardResponses

public Map<ShardRouting,SyncedFlushService.ShardSyncedFlushResponse> shardResponses()

Returns:

Individual responses for each shard copy with a detailed failure message if the copy failed to perform the synced flush. Empty if synced flush failed before step three.

shardId

public ShardId shardId()

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

readShardsSyncedFlushResult

public static ShardsSyncedFlushResult readShardsSyncedFlushResult(StreamInput in)
                                                           throws IOException

Throws:

IOException