Class SnapshotStatus
- java.lang.Object
-
- org.elasticsearch.action.admin.cluster.snapshots.status.SnapshotStatus
-
- All Implemented Interfaces:
Streamable
,ToXContent
,ToXContentObject
public class SnapshotStatus extends java.lang.Object implements ToXContentObject, Streamable
Status of a snapshot
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
-
Field Summary
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object o)
static SnapshotStatus
fromXContent(XContentParser parser)
java.util.Map<java.lang.String,SnapshotIndexStatus>
getIndices()
Returns list of snapshot indicesjava.util.List<SnapshotIndexShardStatus>
getShards()
Returns list of snapshot shardsSnapshotShardsStats
getShardsStats()
Snapshot
getSnapshot()
Returns snapshotSnapshotsInProgress.State
getState()
Returns snapshot stateSnapshotStats
getStats()
Returns number of files in the snapshotint
hashCode()
java.lang.Boolean
includeGlobalState()
Returns true if global state is included in the snapshot, false otherwise.void
readFrom(StreamInput in)
Set this object's fields from a StreamInput.static SnapshotStatus
readSnapshotStatus(StreamInput in)
Reads snapshot status from stream inputjava.lang.String
toString()
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, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
-
-
-
Method Detail
-
getSnapshot
public Snapshot getSnapshot()
Returns snapshot
-
getState
public SnapshotsInProgress.State getState()
Returns snapshot state
-
includeGlobalState
public java.lang.Boolean includeGlobalState()
Returns true if global state is included in the snapshot, false otherwise. Can be null if this information is unknown.
-
getShards
public java.util.List<SnapshotIndexShardStatus> getShards()
Returns list of snapshot shards
-
getShardsStats
public SnapshotShardsStats getShardsStats()
-
getIndices
public java.util.Map<java.lang.String,SnapshotIndexStatus> getIndices()
Returns list of snapshot indices
-
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 interfaceStreamable
- 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 interfaceStreamable
- Throws:
java.io.IOException
-
readSnapshotStatus
public static SnapshotStatus readSnapshotStatus(StreamInput in) throws java.io.IOException
Reads snapshot status from stream input- Parameters:
in
- stream input- Returns:
- deserialized snapshot status
- Throws:
java.io.IOException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getStats
public SnapshotStats getStats()
Returns number of files in the snapshot
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
fromXContent
public static SnapshotStatus fromXContent(XContentParser parser) throws java.io.IOException
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-