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

Class CreateSnapshotResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

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

All Implemented Interfaces:

Streamable, Writeable, ToXContent, ToXContentObject

public class CreateSnapshotResponse
extends ActionResponse
implements ToXContentObject

Create snapshot response

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

TransportResponse.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.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
SnapshotInfo	getSnapshotInfo()	Returns snapshot information if snapshot was completed by the time this method returned or null otherwise.
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
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)	Write this object's fields to a StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

newWriteableReader

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

isFragment

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

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 java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionResponse

Throws:

java.io.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 java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException