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

Class CreateSnapshotResponse

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportResponse

org.opensearch.action.ActionResponse

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

All Implemented Interfaces:

Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject

public class CreateSnapshotResponse
extends ActionResponse
implements org.opensearch.common.xcontent.ToXContentObject

Create snapshot response

Nested Class Summary

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

TransportResponse.Empty

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

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CreateSnapshotResponse(StreamInput in)
CreateSnapshotResponse(SnapshotInfo snapshotInfo)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
static CreateSnapshotResponse	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
SnapshotInfo	getSnapshotInfo()	Returns snapshot information if snapshot was completed by the time this method returned or null otherwise.
int	hashCode()
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
java.lang.String	toString()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

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

isFragment

Constructor Details

CreateSnapshotResponse

public CreateSnapshotResponse(@Nullable SnapshotInfo snapshotInfo)

CreateSnapshotResponse

public CreateSnapshotResponse(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

Method Details

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

writeTo

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

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

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 org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

java.io.IOException

fromXContent

public static CreateSnapshotResponse fromXContent(org.opensearch.common.xcontent.XContentParser parser)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object