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

Class S3Source

java.lang.Object
ai.docling.serve.api.convert.request.source.Source
ai.docling.serve.api.convert.request.source.S3Source
public final class S3Source extends Source
Represents a data source located in S3. This class provides functionality for accessing objects stored in an S3 bucket.

  • Method Details

    • builder

      public static @NonNull S3Source.Builder builder()

    • toBuilder

      public @NonNull S3Source.Builder toBuilder()

    • getEndpoint

      @NonNull public @NonNull String getEndpoint()
      S3 service endpoint, without protocol.
      Returns:
      the S3 service endpoint, without protocol.

    • getAccessKey

      @NonNull public @NonNull String getAccessKey()
      S3 access key
      Returns:
      S3 access key

    • getSecretKey

      @NonNull public @NonNull String getSecretKey()
      S3 secret key
      Returns:
      S3 secret key

    • getBucket

      @NonNull public @NonNull String getBucket()
      S3 bucket name
      Returns:
      S3 bucket name

    • getKeyPrefix

      public String getKeyPrefix()
      Prefix for the object keys on s3
      Returns:
      Prefix for the object keys on s3

    • isVerifySsl

      public boolean isVerifySsl()
      If enabled, SSL will be used to connect to s3. Defaults to true.
      Returns:
      If enabled, SSL will be used to connect to s3. Defaults to true.

    • getMaxNumElements

      public @Nullable Integer getMaxNumElements()
      Maximum number of elements to read from S3. When set, limits the number of objects processed. Useful for batch conversions where the S3 source may contain a large number of objects.
      Returns:
      Maximum number of elements to read from S3.

    • toString

      public @NonNull String toString()
      Overrides:
      toString in class Source