org.elasticsearch.action.admin.cluster.snapshots.create

Class CreateSnapshotResponse

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.admin.cluster.snapshots.create.CreateSnapshotResponse

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable, ToXContent

public class CreateSnapshotResponse
extends ActionResponse
implements ToXContent

Create snapshot response

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse

TransportResponse.Empty

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

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

EMPTY_PARAMS

Method Summary

Methods

Modifier and Type	Method and Description
SnapshotInfo	getSnapshotInfo() Returns snapshot information if snapshot was completed by the time this method returned or null otherwise.
void	readFrom(StreamInput in)
RestStatus	status() Returns HTTP status RestStatus.ACCEPTED if snapshot is still in progress RestStatus.OK if snapshot was successful or partially successful RestStatus.INTERNAL_SERVER_ERROR if snapshot failed completely
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Method Detail

getSnapshotInfo

public SnapshotInfo getSnapshotInfo()

Returns snapshot information if snapshot was completed by the time this method returned or null otherwise.

Returns:

snapshot information or null

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionResponse

Throws:

IOException

status

public RestStatus status()

Returns HTTP status

• RestStatus.ACCEPTED if snapshot is still in progress
• RestStatus.OK if snapshot was successful or partially successful
• RestStatus.INTERNAL_SERVER_ERROR if snapshot failed completely

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException