Module org.elasticsearch.server

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

Class GetSampleConfigurationAction.Response

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

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

All Implemented Interfaces:

Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted

Enclosing class:

GetSampleConfigurationAction

public static class GetSampleConfigurationAction.Response
extends ActionResponse
implements ChunkedToXContentObject

Response object containing the sampling configuration for a specific index.

This response contains the index name and its associated sampling configuration. The response is designed to match the expected JSON format with an array containing a single object with "index" and "configuration" fields.

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(String index, SamplingConfiguration configuration)	Constructs a new Response with the given index and configuration.
Response(StreamInput in)	Constructs a new Response by deserializing from a StreamInput.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
SamplingConfiguration	getConfiguration()	Gets the sampling configuration for the index.
String	getIndex()	Gets the index name.
int	hashCode()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)	Create an iterator of ToXContent chunks for a REST response.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

toXContentChunked, toXContentChunkedV8

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

isFragment

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Constructor Details

Response

public Response(String index,
 SamplingConfiguration configuration)

Constructs a new Response with the given index and configuration.

Parameters:

index - the index name

configuration - the sampling configuration for the index, or null if no configuration exists

Response

public Response(StreamInput in)
         throws IOException

Constructs a new Response by deserializing from a StreamInput.

Parameters:

in - the stream input to read from

Throws:

IOException - if an I/O error occurs during deserialization

Method Details

getIndex

public String getIndex()

Gets the index name.

Returns:

the index name

getConfiguration

public SamplingConfiguration getConfiguration()

Gets the sampling configuration for the index.

Returns:

the sampling configuration, or null if no configuration exists for this index

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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