Package org.a2aproject.sdk.jsonrpc.common.wrappers

Class CancelTaskRequest

java.lang.Object

org.a2aproject.sdk.jsonrpc.common.wrappers.A2ARequest<T>

org.a2aproject.sdk.jsonrpc.common.wrappers.NonStreamingJSONRPCRequest<CancelTaskParams>

org.a2aproject.sdk.jsonrpc.common.wrappers.CancelTaskRequest

All Implemented Interfaces:

A2AMessage

public final class CancelTaskRequest
extends NonStreamingJSONRPCRequest<CancelTaskParams>

JSON-RPC request to cancel an in-progress task.

This request instructs the agent to cancel execution of a specific task identified by ID. The agent should stop processing, clean up resources, and transition the task to TaskState.TASK_STATE_CANCELED state if cancellation is possible.

Not all tasks can be canceled (e.g., already completed tasks), which may result in a TaskNotCancelableError.

This class implements the JSON-RPC tasks/cancel method as specified in the A2A Protocol.

See Also:

• for the corresponding response
• for the parameter structure
• for the error when cancellation is not possible
• A2A Protocol Specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CancelTaskRequest.Builder	Builder for constructing CancelTaskRequest instances.

Field Summary

Fields inherited from class org.a2aproject.sdk.jsonrpc.common.wrappers.A2ARequest

id, jsonrpc, method, params

Fields inherited from interface org.a2aproject.sdk.jsonrpc.common.wrappers.A2AMessage

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
CancelTaskRequest(Object id, CancelTaskParams params)	Creates a new CancelTaskRequest with default JSON-RPC version and method.
CancelTaskRequest(String jsonrpc, Object id, CancelTaskParams params)	Creates a new CancelTaskRequest with the specified JSON-RPC parameters.

Method Summary

Modifier and Type	Method	Description
static CancelTaskRequest.Builder	builder()	Create a new Builder

Methods inherited from class org.a2aproject.sdk.jsonrpc.common.wrappers.A2ARequest

getId, getJsonrpc, getMethod, getParams, validateAndSetJsonParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CancelTaskRequest

public CancelTaskRequest(String jsonrpc,
 Object id,
 CancelTaskParams params)

Creates a new CancelTaskRequest with the specified JSON-RPC parameters.

Parameters:

jsonrpc - the JSON-RPC version (defaults to "2.0" if null)

id - the request identifier (string, integer, or null)

params - the request parameters containing the task ID

Throws:

IllegalArgumentException - if jsonrpc version is invalid, method is not "CancelTask", params is null, or id is not a String/Integer/null

CancelTaskRequest

public CancelTaskRequest(Object id,
 CancelTaskParams params)

Creates a new CancelTaskRequest with default JSON-RPC version and method.

Parameters:

id - the request identifier (string, integer, or null)

params - the request parameters containing the task ID

Throws:

IllegalArgumentException - if params is null or id is not a string/integer/null

Method Details

builder

public static CancelTaskRequest.Builder builder()

Create a new Builder

Returns:

the builder