Module org.elasticsearch.server
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
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
Fields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED
-
Constructor Summary
ConstructorDescriptionGetSnapshotsResponse
(List<SnapshotInfo> snapshots, Map<String, ElasticsearchException> failures, String next, int total, int remaining) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static GetSnapshotsResponse
fromXContent
(XContentParser parser) Returns a map of repository name toElasticsearchException
for each unsuccessful response.Returns the list of snapshotsint
hashCode()
boolean
isFailed()
Returns true if there is at least one failed response.next()
int
toString()
int
toXContentChunked
(ToXContent.Params params) Create an iterator ofToXContent
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
Methods inherited from interface org.elasticsearch.core.RefCounted
mustIncRef
-
Constructor Details
-
GetSnapshotsResponse
public GetSnapshotsResponse(List<SnapshotInfo> snapshots, Map<String, ElasticsearchException> failures, @Nullable String next, int total, int remaining) -
GetSnapshotsResponse
- Throws:
IOException
-
-
Method Details
-
getSnapshots
Returns the list of snapshots- Returns:
- the list of snapshots
-
getFailures
Returns a map of repository name toElasticsearchException
for each unsuccessful response. -
next
-
isFailed
public boolean isFailed()Returns true if there is at least one failed response. -
totalCount
public int totalCount() -
remaining
public int remaining() -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
toXContentChunked
Description copied from interface:ChunkedToXContent
Create an iterator ofToXContent
chunks for a REST response. Each chunk is serialized with the sameXContentBuilder
andToXContent.Params
, which is also the same as theToXContent.Params
passed as theparams
argument. For best results, all chunks should beO(1)
size. The last chunk in the iterator must always yield at least one byte of output. See alsoChunkedToXContentHelper
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 interfaceChunkedToXContent
- Returns:
- iterator over chunks of
ToXContent
-
fromXContent
- Throws:
IOException
-
equals
-
hashCode
public int hashCode() -
toString
-