org.elasticsearch.action

Class ActionWriteResponse.ShardInfo

java.lang.Object

org.elasticsearch.action.ActionWriteResponse.ShardInfo

All Implemented Interfaces:

Streamable, ToXContent

Enclosing class:

ActionWriteResponse

public static class ActionWriteResponse.ShardInfo
extends Object
implements Streamable, ToXContent

Nested Class Summary

Nested Classes

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

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
ActionWriteResponse.ShardInfo()
ActionWriteResponse.ShardInfo(int total, int successful, ActionWriteResponse.ShardInfo.Failure... failures)

Method Summary

Methods

Modifier and Type	Method and Description
int	getFailed()
ActionWriteResponse.ShardInfo.Failure[]	getFailures()
int	getSuccessful()
int	getTotal()
void	readFrom(StreamInput in)
static ActionWriteResponse.ShardInfo	readShardInfo(StreamInput in)
RestStatus	status()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionWriteResponse.ShardInfo

public ActionWriteResponse.ShardInfo()

ActionWriteResponse.ShardInfo

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

Method Detail

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 ActionWriteResponse.ShardInfo.Failure[] getFailures()

Returns:

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

status

public RestStatus status()

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

readShardInfo

public static ActionWriteResponse.ShardInfo readShardInfo(StreamInput in)
                                                   throws IOException

Throws:

IOException