Package org.elasticsearch.action.admin.indices.dangling.list

Class ListDanglingIndicesResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.nodes.BaseNodesResponse<NodeListDanglingIndicesResponse>

org.elasticsearch.action.admin.indices.dangling.list.ListDanglingIndicesResponse

All Implemented Interfaces:

Writeable, StatusToXContentObject, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.core.RefCounted

public class ListDanglingIndicesResponse
extends BaseNodesResponse<NodeListDanglingIndicesResponse>
implements StatusToXContentObject

Models a response to a ListDanglingIndicesRequest. A list request queries every node in the cluster and aggregates their responses. When the aggregated response is converted to XContent, information for each dangling index is presented under the "dangling_indices" key. If any nodes in the cluster failed to answer, the details are presented under the "_nodes.failures" key.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

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

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

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

Constructor Summary

Constructors

Constructor	Description
ListDanglingIndicesResponse(ClusterName clusterName, List<NodeListDanglingIndicesResponse> nodes, List<FailedNodeException> failures)
ListDanglingIndicesResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected List<NodeListDanglingIndicesResponse>	readNodesFrom(StreamInput in)	Read the BaseNodesResponse.nodes from the stream.
RestStatus	status()	Returns the REST status to make sure it is returned correctly
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
protected void	writeNodesTo(StreamOutput out, List<NodeListDanglingIndicesResponse> nodes)	Write the BaseNodesResponse.nodes to the stream.

Methods inherited from class org.elasticsearch.action.support.nodes.BaseNodesResponse

failures, getClusterName, getNodes, getNodesMap, hasFailures, writeTo

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, incRef, remoteAddress, remoteAddress, tryIncRef

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.xcontent.ToXContentObject

isFragment

Constructor Details

ListDanglingIndicesResponse

public ListDanglingIndicesResponse(StreamInput in)
                            throws IOException

Throws:

IOException

ListDanglingIndicesResponse

public ListDanglingIndicesResponse(ClusterName clusterName,
 List<NodeListDanglingIndicesResponse> nodes,
 List<FailedNodeException> failures)

Method Details

status

public RestStatus status()

Description copied from interface: StatusToXContentObject

Returns the REST status to make sure it is returned correctly

Specified by:

status in interface StatusToXContentObject

toXContent

public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws IOException

Specified by:

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

Throws:

IOException

readNodesFrom

protected List<NodeListDanglingIndicesResponse> readNodesFrom(StreamInput in)
                                                       throws IOException

Description copied from class: BaseNodesResponse

Read the BaseNodesResponse.nodes from the stream.

Specified by:

readNodesFrom in class BaseNodesResponse<NodeListDanglingIndicesResponse>

Returns:

Never null.

Throws:

IOException

writeNodesTo

protected void writeNodesTo(StreamOutput out,
 List<NodeListDanglingIndicesResponse> nodes)
                     throws IOException

Description copied from class: BaseNodesResponse

Write the BaseNodesResponse.nodes to the stream.

Specified by:

writeNodesTo in class BaseNodesResponse<NodeListDanglingIndicesResponse>

Throws:

IOException