Module org.elasticsearch.server

Package org.elasticsearch.action.admin.indices.sampling

Class GetSampleAction.Response

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.nodes.BaseNodesResponse<GetSampleAction.NodeResponse>

org.elasticsearch.action.admin.indices.sampling.GetSampleAction.Response

All Implemented Interfaces:

Writeable, ChunkedToXContent, RefCounted

Enclosing class:

GetSampleAction

public static class GetSampleAction.Response
extends BaseNodesResponse<GetSampleAction.NodeResponse>
implements Writeable, ChunkedToXContent

Nested Class Summary

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

ActionResponse.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.ChunkedToXContent

EMPTY

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
Response(ClusterName clusterName, List<GetSampleAction.NodeResponse> nodes, List<FailedNodeException> failures, int maxSize)
Response(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<SamplingService.RawDocument>	getSample()
int	hashCode()
protected List<GetSampleAction.NodeResponse>	readNodesFrom(StreamInput in)	Read the BaseNodesResponse.nodes from the stream.
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)	Create an iterator of ToXContent chunks for a REST response.
protected void	writeNodesTo(StreamOutput out, List<GetSampleAction.NodeResponse> nodes)	Write the BaseNodesResponse.nodes to the stream.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

failures, getClusterName, getNodes, getNodesMap, hasFailures

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

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

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

isFragment, toXContentChunked, toXContentChunkedV8

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Constructor Details

Response

public Response(StreamInput in)
         throws IOException

Throws:

IOException

Response

public Response(ClusterName clusterName,
 List<GetSampleAction.NodeResponse> nodes,
 List<FailedNodeException> failures,
 int maxSize)

Method Details

getSample

public List<SamplingService.RawDocument> getSample()

readNodesFrom

protected List<GetSampleAction.NodeResponse> readNodesFrom(StreamInput in)
                                                    throws IOException

Description copied from class: BaseNodesResponse

Read the BaseNodesResponse.nodes from the stream.

Specified by:

readNodesFrom in class BaseNodesResponse<GetSampleAction.NodeResponse>

Returns:

Never null.

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BaseNodesResponse<GetSampleAction.NodeResponse>

Throws:

IOException

writeNodesTo

protected void writeNodesTo(StreamOutput out,
 List<GetSampleAction.NodeResponse> nodes)
                     throws IOException

Description copied from class: BaseNodesResponse

Write the BaseNodesResponse.nodes to the stream.

Specified by:

writeNodesTo in class BaseNodesResponse<GetSampleAction.NodeResponse>

Throws:

IOException

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object