Package ai.docling.serve.api.convert.response

Enum Class ResponseType

java.lang.Object

java.lang.Enum<ResponseType>

ai.docling.serve.api.convert.response.ResponseType

All Implemented Interfaces:

Serializable, Comparable<ResponseType>, Constable

public enum ResponseType
extends Enum<ResponseType>

Defines the response type for document conversion operations.

Each enumeration value corresponds to a specific response format and determines how the converted document content is delivered to the client:

• IN_BODY - Content is embedded directly in the response body (InBodyConvertDocumentResponse)
• ZIP_ARCHIVE - Content is packaged and returned as a ZIP archive (ZipArchiveConvertDocumentResponse)
• PRE_SIGNED_URL - Content is packaged as a ZIP archive and uploaded to the given target URI and statistical information is returned. (PreSignedUrlConvertDocumentResponse)

See Also:

• ConvertDocumentResponse
• InBodyConvertDocumentResponse
• ZipArchiveConvertDocumentResponse
• PreSignedUrlConvertDocumentResponse

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IN_BODY	Represents response type - InBodyConvertDocumentResponse
PRE_SIGNED_URL	Represents response type - PreSignedUrlConvertDocumentResponse
ZIP_ARCHIVE	Represents response type - ZipArchiveConvertDocumentResponse

Method Summary

Modifier and Type	Method	Description
static ResponseType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ResponseType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IN_BODY

public static final ResponseType IN_BODY

Represents response type - InBodyConvertDocumentResponse

ZIP_ARCHIVE

public static final ResponseType ZIP_ARCHIVE

Represents response type - ZipArchiveConvertDocumentResponse

PRE_SIGNED_URL

public static final ResponseType PRE_SIGNED_URL

Represents response type - PreSignedUrlConvertDocumentResponse

Method Details

values

public static ResponseType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ResponseType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null