CancelTasksResponse (server 1.2.0 API)

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportResponse

org.opensearch.action.ActionResponse

org.opensearch.action.support.tasks.BaseTasksResponse

org.opensearch.action.admin.cluster.node.tasks.list.ListTasksResponse

org.opensearch.action.admin.cluster.node.tasks.cancel.CancelTasksResponse

All Implemented Interfaces:: Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject

public class CancelTasksResponse
extends ListTasksResponse

Returns the list of tasks that were cancelled

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.transport.TransportResponse
TransportResponse.Empty

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent
org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
Field Summary

Fields inherited from class org.opensearch.action.support.tasks.BaseTasksResponse
NODE_FAILURES, TASK_FAILURES

Fields inherited from interface org.opensearch.common.xcontent.ToXContent
EMPTY_PARAMS

Constructor Summary

Constructors
Constructor	Description
`CancelTasksResponse(java.util.List<TaskInfo> tasks, java.util.List<TaskOperationFailure> taskFailures, java.util.List<? extends OpenSearchException> nodeFailures)`
`CancelTasksResponse(StreamInput in)`

Method Summary

Modifier and Type	Method	Description
`static CancelTasksResponse`	`fromXContent(org.opensearch.common.xcontent.XContentParser parser)`
`java.lang.String`	`toString()`
`org.opensearch.common.xcontent.XContentBuilder`	`toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)`

Methods inherited from class org.opensearch.action.admin.cluster.node.tasks.list.ListTasksResponse

getPerNodeTasks, getTaskGroups, getTasks, setupParser, toXContentGroupedByNode, toXContentGroupedByNone, toXContentGroupedByParents, writeTo

Methods inherited from class org.opensearch.action.support.tasks.BaseTasksResponse

equals, getNodeFailures, getTaskFailures, hashCode, rethrowFailures, toXContentCommon

Methods inherited from class org.opensearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.xcontent.ToXContentObject

isFragment

Constructor Details
- CancelTasksResponse
  
  public CancelTasksResponse(StreamInput in) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
- CancelTasksResponse
  
  public CancelTasksResponse(java.util.List<TaskInfo> tasks, java.util.List<TaskOperationFailure> taskFailures, java.util.List<? extends OpenSearchException> nodeFailures)
Method Details
- toXContent
  
  public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
  
  Specified by:
  
  toXContent in interface org.opensearch.common.xcontent.ToXContent
  
  Overrides:
  
  toXContent in class ListTasksResponse
  
  Throws:
  
  java.io.IOException
- fromXContent
  
  public static CancelTasksResponse fromXContent(org.opensearch.common.xcontent.XContentParser parser)
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class ListTasksResponse