Module org.elasticsearch.server

Package org.elasticsearch.health

Class GetHealthAction.Response

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.health.GetHealthAction.Response

All Implemented Interfaces:

Writeable, ChunkedToXContent, RefCounted

Enclosing class:

GetHealthAction

public static class GetHealthAction.Response
extends ActionResponse
implements 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<HealthIndicatorResult> indicators, boolean showTopLevelStatus)
Response(ClusterName clusterName, List<HealthIndicatorResult> indicators, HealthStatus topLevelStatus)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
HealthIndicatorResult	findIndicator(String name)
ClusterName	getClusterName()
List<HealthIndicatorResult>	getIndicatorResults()
HealthStatus	getStatus()
int	hashCode()
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params outerParams)	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, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

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

isFragment, toXContentChunkedV7

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Constructor Details

Response

public Response(ClusterName clusterName,
 List<HealthIndicatorResult> indicators,
 boolean showTopLevelStatus)

Response

public Response(ClusterName clusterName,
 List<HealthIndicatorResult> indicators,
 HealthStatus topLevelStatus)

Method Details

getClusterName

public ClusterName getClusterName()

getStatus

public HealthStatus getStatus()

findIndicator

public HealthIndicatorResult findIndicator(String name)

getIndicatorResults

public List<HealthIndicatorResult> getIndicatorResults()

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

toXContentChunked

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

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

toString

public String toString()

Overrides:

toString in class Object