Package ai.docling.serve.api.clear.response

Class ClearResponse

java.lang.Object

ai.docling.serve.api.clear.response.ClearResponse

public class ClearResponse
extends Object

Represents the response returned when performing a "clear" operation within the Docling API. This response typically communicates the status of the clear operation, indicating success, failure, or other relevant information. The response includes a status field, which may provide additional details about the operation's outcome. The status field is optional and may be null or empty if no specific status message is provided. This class is immutable and is constructed using the ClearResponse.Builder.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static @NonNull ClearResponse.Builder	builder()
@Nullable String	getStatus()	Status of the clear operation.
@NonNull ClearResponse.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 ClearResponse.Builder builder()

toBuilder

public @NonNull ClearResponse.Builder toBuilder()

getStatus

public @Nullable String getStatus()

Status of the clear operation.

Returns:

the status message, or null if not provided

toString

public @NonNull String toString()

Overrides:

toString in class Object