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

Class PutTarget

java.lang.Object

ai.docling.serve.api.convert.request.target.Target

ai.docling.serve.api.convert.request.target.PutTarget

public final class PutTarget
extends Target

A concrete Target implementation for delivering a converted document to a specified URI via an HTTP PUT operation.

The PutTarget class represents a delivery method where the document is sent to the given URL. Supported serialized fields include:

• kind - inherited from the Target base class and always set to PUT for this implementation.
• url - the URI to which the document should be delivered.

This class provides JSON serialization annotations to include only non-empty fields in the serialization output. The url is nullable, allowing the absence of a URI to be explicitly represented.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static @NonNull PutTarget.Builder	builder()
@NonNull URI	getUrl()	The URL to which the converted document should be uploaded via HTTP PUT.
@NonNull PutTarget.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 PutTarget.Builder builder()

toBuilder

public @NonNull PutTarget.Builder toBuilder()

getUrl

@NonNull
public @NonNull URI getUrl()

The URL to which the converted document should be uploaded via HTTP PUT. Must be a valid URI that accepts PUT requests.

Returns:

the target URL for PUT requests

toString

public @NonNull String toString()

Overrides:

toString in class Target