Package ai.docling.serve.api.task.request

Class TaskResultRequest

java.lang.Object

ai.docling.serve.api.task.request.TaskResultRequest

public class TaskResultRequest
extends Object

Represents a request to retrieve the result of a task. This class is used to encapsulate the necessary information required to request the result corresponding to the task identified by its unique task ID. Instances of this class are immutable and can be built using the provided builder methods. Attributes: - `taskId`: The unique identifier of the task whose result is being requested. This field is mandatory and must not be null.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TaskResultRequest.Builder
static class	TaskResultRequest.TaskResultRequestBuilder	Builder for creating TaskResultRequest instances.

Method Summary

Modifier and Type	Method	Description
static @NonNull TaskResultRequest.Builder	builder()
@NonNull String	getTaskId()	The unique identifier of the task whose result is being requested.
@NonNull TaskResultRequest.Builder	toBuilder()
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static @NonNull TaskResultRequest.Builder builder()

toBuilder

public @NonNull TaskResultRequest.Builder toBuilder()

getTaskId

@NonNull
public @NonNull String getTaskId()

The unique identifier of the task whose result is being requested.

Returns:

the task ID

toString

public @NonNull String toString()

Overrides:

toString in class Object