Module org.elasticsearch.server

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

Class SnapshotsStatusResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.admin.cluster.snapshots.status.SnapshotsStatusResponse

All Implemented Interfaces:

Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted

public class SnapshotsStatusResponse
extends ActionResponse
implements ChunkedToXContentObject

Snapshot status 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

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
SnapshotsStatusResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static SnapshotsStatusResponse	fromXContent(XContentParser parser)
List<SnapshotStatus>	getSnapshots()	Returns the list of snapshots
int	hashCode()
Iterator<? extends 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, toString, wait, wait, wait

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

toXContentChunkedV7

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

isFragment

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Constructor Details

SnapshotsStatusResponse

public SnapshotsStatusResponse(StreamInput in)
                        throws IOException

Throws:

IOException

Method Details

getSnapshots

public List<SnapshotStatus> getSnapshots()

Returns the list of snapshots

Returns:

the list of snapshots

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

fromXContent

public static SnapshotsStatusResponse 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

toXContentChunked

public Iterator<? extends 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. The last chunk in the iterator must always yield at least one byte of output. 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