Record Class CancelTaskParams

java.lang.Object
java.lang.Record
org.a2aproject.sdk.spec.CancelTaskParams
Record Components:
id - the unique task identifier (required)
tenant - optional tenant, provided as a path parameter
metadata - optional arbitrary key-value metadata (e.g. cancellation reason)

public record CancelTaskParams(String id, @Nullable String tenant, Map<String,Object> metadata) extends Record
Parameters for cancelling a task.

Carries the task identifier and optional tenant and metadata for cancel-specific context, such as a cancellation reason or source system.

See Also:
  • Constructor Details

    • CancelTaskParams

      public CancelTaskParams(String id, @Nullable String tenant, Map<String,Object> metadata)
      Compact constructor for validation. Validates that required parameters are not null.
      Parameters:
      id - the task identifier
      tenant - the tenant identifier
    • CancelTaskParams

      public CancelTaskParams(String id)
      Convenience constructor with default tenant.
      Parameters:
      id - the task identifier (required)
  • Method Details

    • builder

      public static CancelTaskParams.Builder builder()
      Create a new Builder
      Returns:
      the builder
    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • id

      public String id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component
    • tenant

      public @Nullable String tenant()
      Returns the value of the tenant record component.
      Returns:
      the value of the tenant record component
    • metadata

      public Map<String,Object> metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component