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

Class ZipArchiveConvertDocumentResponse.Builder

java.lang.Object

ai.docling.serve.api.convert.response.ZipArchiveConvertDocumentResponse.Builder

Enclosing class:

ZipArchiveConvertDocumentResponse

public static class ZipArchiveConvertDocumentResponse.Builder
extends Object

Builder for creating ZipArchiveConvertDocumentResponse instances. Generated by Lombok's @Builder annotation.

Builder methods:

• fileName(String) - Set the ZIP archive file name
• inputStream(InputStream) - Set the input stream for the ZIP archive

Method Summary

Modifier and Type	Method	Description
@NonNull ZipArchiveConvertDocumentResponse	build()
@NonNull ZipArchiveConvertDocumentResponse.Builder	fileName(String fileName)	Name of the ZIP archive file containing the converted documents.
@NonNull ZipArchiveConvertDocumentResponse.Builder	inputStream(InputStream inputStream)	Input stream for reading the ZIP archive contents.
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Method Details

fileName

public @NonNull ZipArchiveConvertDocumentResponse.Builder fileName(String fileName)

Name of the ZIP archive file containing the converted documents.

This is the suggested filename for saving the ZIP archive locally.

Parameters:

fileName - the ZIP archive file name

Returns:

this.

inputStream

public @NonNull ZipArchiveConvertDocumentResponse.Builder inputStream(InputStream inputStream)

Input stream for reading the ZIP archive contents.

This stream provides access to the binary ZIP file data containing all converted documents and their assets. The stream should be properly closed after reading to release resources.

Note: This field is typically not serialized to JSON as it represents binary data. It's used for programmatic access to the ZIP archive contents.

Parameters:

inputStream - the input stream for the ZIP archive

Returns:

this.

build

public @NonNull ZipArchiveConvertDocumentResponse build()

toString

public @NonNull String toString()

Overrides:

toString in class Object