Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.snapshots.get

Class GetSnapshotsResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.admin.cluster.snapshots.get.GetSnapshotsResponse

All Implemented Interfaces:

Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted

public class GetSnapshotsResponse
extends ActionResponse
implements ChunkedToXContentObject

Get snapshots response

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

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.common.xcontent.ChunkedToXContent

EMPTY

Constructor Summary

Constructors

Constructor	Description
GetSnapshotsResponse(List<SnapshotInfo> snapshots, Map<String,ElasticsearchException> failures, String next, int total, int remaining)
GetSnapshotsResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static GetSnapshotsResponse	fromXContent(XContentParser parser)
Map<String,ElasticsearchException>	getFailures()	Returns a map of repository name to ElasticsearchException for each unsuccessful response.
List<SnapshotInfo>	getSnapshots()	Returns the list of snapshots
int	hashCode()
boolean	isFailed()	Returns true if there is at least one failed response.
String	next()
int	remaining()
String	toString()
int	totalCount()
Iterator<ToXContent>	toXContentChunked(ToXContent.Params params)	Create an iterator of ToXContent chunks for a REST response.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

toXContentChunkedV7

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContentObject

isFragment

Constructor Details

GetSnapshotsResponse

public GetSnapshotsResponse(List<SnapshotInfo> snapshots,
 Map<String,ElasticsearchException> failures,
 @Nullable
 String next,
 int total,
 int remaining)

GetSnapshotsResponse

public GetSnapshotsResponse(StreamInput in)
                     throws IOException

Throws:

IOException

Method Details

getSnapshots

public List<SnapshotInfo> getSnapshots()

Returns the list of snapshots

Returns:

the list of snapshots

getFailures

public Map<String,ElasticsearchException> getFailures()

Returns a map of repository name to ElasticsearchException for each unsuccessful response.

next

@Nullable
public String next()

isFailed

public boolean isFailed()

Returns true if there is at least one failed response.

totalCount

public int totalCount()

remaining

public int remaining()

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

toXContentChunked

public Iterator<ToXContent> toXContentChunked(ToXContent.Params params)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent

fromXContent

public static GetSnapshotsResponse fromXContent(XContentParser parser)
                                         throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object