Package org.elasticsearch.action.support.replication

Class ReplicationResponse.ShardInfo

java.lang.Object

org.elasticsearch.action.support.replication.ReplicationResponse.ShardInfo

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

ReplicationResponse

public static class ReplicationResponse.ShardInfo
extends Object
implements Writeable, ToXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReplicationResponse.ShardInfo.Failure

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ShardInfo()
ShardInfo(int total, int successful, ReplicationResponse.ShardInfo.Failure... failures)
ShardInfo(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static ReplicationResponse.ShardInfo	fromXContent(XContentParser parser)
int	getFailed()
ReplicationResponse.ShardInfo.Failure[]	getFailures()
int	getSuccessful()
int	getTotal()
RestStatus	status()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

ShardInfo

public ShardInfo()

ShardInfo

public ShardInfo(StreamInput in)
          throws IOException

Throws:

IOException

ShardInfo

public ShardInfo(int total,
 int successful,
 ReplicationResponse.ShardInfo.Failure... failures)

Method Details

getTotal

public int getTotal()

Returns:

the total number of shards the write should go to (replicas and primaries). This includes relocating shards, so this number can be higher than the number of shards.

getSuccessful

public int getSuccessful()

Returns:

the total number of shards the write succeeded on (replicas and primaries). This includes relocating shards, so this number can be higher than the number of shards.

getFailed

public int getFailed()

Returns:

The total number of replication failures.

getFailures

public ReplicationResponse.ShardInfo.Failure[] getFailures()

Returns:

The replication failures that have been captured in the case writes have failed on replica shards.

status

public RestStatus status()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static ReplicationResponse.ShardInfo fromXContent(XContentParser parser)
                                                  throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object