Interface IPromptBinaryData

All Superinterfaces:
Serializable
public interface IPromptBinaryData extends Serializable

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    fileName()
    The name of the file, e.g.
    int
    fileSize()
    The size of the file in bytes.
    Instant
    lastModified()
    The time the file was last modified.
    String
    mimeType()
    The MIME type of the binary data, e.g.
    InputStream
    open()
    Opens an input stream to the binary data.

  • Method Details

    • fileName

      String fileName()
      The name of the file, e.g. "image.png", "data.json", etc.
      Returns:
      The name of the file

    • fileSize

      int fileSize()
      The size of the file in bytes.
      Returns:
      The size of the file

    • lastModified

      Instant lastModified()
      The time the file was last modified. For newly created files, this is the time of creation
      Returns:
      The last modified timestamp of the file

    • mimeType

      String mimeType()
      The MIME type of the binary data, e.g. "image/png", "application/json", etc. For plain text files, it should contain an encoding, e.g. "text/plain; charset=UTF-8". If no encoding is specified, defaults to UTF-8. When the mime type is empty, defaults to "application/octet-stream".
      Returns:
      The MIME type of the binary data

    • open

      InputStream open() throws IOException
      Opens an input stream to the binary data. The stream must be closed by the caller.
      Returns:
      An input stream with the binary data.
      Throws:
      IOException - If an I/O error occurs while opening the stream.