Package ai.docling.serve.api.convert.request

Class CallbackSpec

java.lang.Object

ai.docling.serve.api.convert.request.CallbackSpec

public class CallbackSpec
extends Object

Represents a webhook callback specification for batch conversion progress notifications. When configured, the server sends POST requests to the specified URL with progress updates as documents are processed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CallbackSpec.Builder

Method Summary

Modifier and Type	Method	Description
static @NonNull CallbackSpec.Builder	builder()
@Nullable String	getCaCert()	Custom CA certificate (PEM) for endpoint verification.
Map<String,Object>	getHeaders()	Additional headers sent with callback requests.
@NonNull URI	getUrl()	The webhook URL that receives POST progress updates.
@NonNull CallbackSpec.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 CallbackSpec.Builder builder()

toBuilder

public @NonNull CallbackSpec.Builder toBuilder()

getUrl

@NonNull
public @NonNull URI getUrl()

The webhook URL that receives POST progress updates.

Returns:

the webhook URL

getHeaders

public Map<String,Object> getHeaders()

Additional headers sent with callback requests.

Returns:

the additional headers

getCaCert

public @Nullable String getCaCert()

Custom CA certificate (PEM) for endpoint verification.

Returns:

the CA certificate in PEM format

toString

public @NonNull String toString()

Overrides:

toString in class Object