Package org.elasticsearch.action.ingest

Class GetPipelineResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.ingest.GetPipelineResponse

All Implemented Interfaces:

Writeable, StatusToXContentObject, RefCounted, ToXContent, ToXContentObject

public class GetPipelineResponse
extends ActionResponse
implements StatusToXContentObject

Nested Class Summary

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

ActionResponse.Empty

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GetPipelineResponse(List<PipelineConfiguration> pipelines)
GetPipelineResponse(List<PipelineConfiguration> pipelines, boolean summary)
GetPipelineResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
static GetPipelineResponse	fromXContent(XContentParser parser)
int	hashCode()
boolean	isFound()
boolean	isSummary()
List<PipelineConfiguration>	pipelines()	Get the list of pipelines that were a part of this response.
RestStatus	status()	Returns the REST status to make sure it is returned correctly
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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.xcontent.ToXContentObject

isFragment

Constructor Details

GetPipelineResponse

public GetPipelineResponse(StreamInput in)
                    throws IOException

Throws:

IOException

GetPipelineResponse

public GetPipelineResponse(List<PipelineConfiguration> pipelines,
 boolean summary)

GetPipelineResponse

public GetPipelineResponse(List<PipelineConfiguration> pipelines)

Method Details

pipelines

public List<PipelineConfiguration> pipelines()

Get the list of pipelines that were a part of this response. The pipeline id can be obtained using getId on the PipelineConfiguration object.

Returns:

A list of PipelineConfiguration objects.

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

isFound

public boolean isFound()

isSummary

public boolean isSummary()

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 XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static GetPipelineResponse fromXContent(XContentParser parser)
                                        throws IOException

Parameters:

parser - the parser for the XContent that contains the serialized GetPipelineResponse.

Returns:

an instance of GetPipelineResponse read from the parser

Throws:

IOException - If the parsing fails

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object