PendingClusterTasksResponse (server 8.13.2 API)

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.admin.cluster.tasks.PendingClusterTasksResponse

All Implemented Interfaces:: Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted

public class PendingClusterTasksResponse 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

PendingClusterTasksResponse(StreamInput in)
Method Summary

Modifier and Type

Method

Description

List<PendingClusterTask>

pendingTasks()

String

toString()

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, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

Methods inherited from interface org.elasticsearch.core.RefCounted
mustIncRef

Constructor Details
- PendingClusterTasksResponse
  
  public PendingClusterTasksResponse(StreamInput in) throws IOException
  
  Throws:
  
  IOException
Method Details
- pendingTasks
  
  public List<PendingClusterTask> pendingTasks()
- toString
  
  public String toString()
  
  Overrides:
  
  toString 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
- 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