Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.inference.action

Class InferenceAction.Response

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.xpack.core.inference.action.InferenceAction.Response

All Implemented Interfaces:

Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted

Enclosing class:

InferenceAction

public static class InferenceAction.Response
extends ActionResponse
implements ChunkedToXContentObject

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(StreamInput in)
Response(InferenceServiceResults results)
Response(InferenceServiceResults results, Flow.Publisher<InferenceServiceResults.Result> publisher)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
InferenceServiceResults	getResults()
int	hashCode()
boolean	isStreaming()	Returns true if these results are streamed as chunks, or false if these results contain the entire payload.
Flow.Publisher<InferenceServiceResults.Result>	publisher()	When isStreaming() is true, the RestHandler will subscribe to this publisher.
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)
void	writeTo(StreamOutput out)

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(InferenceServiceResults results)

Response

public Response(InferenceServiceResults results,
 Flow.Publisher<InferenceServiceResults.Result> publisher)

Response

public Response(StreamInput in)
         throws IOException

Throws:

IOException

Method Details

getResults

public InferenceServiceResults getResults()

isStreaming

public boolean isStreaming()

Returns true if these results are streamed as chunks, or false if these results contain the entire payload. Currently set to false while it is being implemented.

publisher

public Flow.Publisher<InferenceServiceResults.Result> publisher()

When isStreaming() is true, the RestHandler will subscribe to this publisher. When the RestResponse is finished with the current chunk, it will request the next chunk using the subscription. If the RestResponse is closed, it will cancel the subscription.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContentChunked

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

Specified by:

toXContentChunked in interface ChunkedToXContent

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object