Interface File._FinalStage

  • All Known Implementing Classes:
    File.Builder
    Enclosing class:
    File

    public static interface File._FinalStage
    • Method Detail

      • build

        File build()
      • type

        File._FinalStage type​(java.util.Optional<FileType> type)

        The type of the file.

        Availability: Present when the file type could be determined.

      • presignedUrl

        File._FinalStage presignedUrl​(java.util.Optional<java.lang.String> presignedUrl)

        A presigned URL to download the file. Expires after 15 minutes.

        Availability: Present on GET /files/{id}. Not present on POST /files/upload or when the file is embedded in other resources (e.g., in run responses).

      • presignedUrl

        File._FinalStage presignedUrl​(java.lang.String presignedUrl)
      • parentFileId

        File._FinalStage parentFileId​(java.util.Optional<java.lang.String> parentFileId)

        ID of the parent file.

        Availability: Present for files created via a Splitter in a workflow.

      • parentFileId

        File._FinalStage parentFileId​(java.lang.String parentFileId)
      • contents

        File._FinalStage contents​(java.util.Optional<FileContents> contents)

        Deprecated: Use the POST /parse_runs endpoint instead to parse and retrieve file contents. The parse runs endpoint provides more control over parsing configuration and better performance.

        The parsed content of the file. This field will only contain data after the file has been parsed via a parse run, extract run, classify run, split run, edit run, or workflow run.

        Availability: Only present and populated on GET /files/{id} when the file has been previously parsed and the corresponding query parameters are set to true. Will be null on POST /files/upload and for files that haven't been parsed. The structure varies based on file type.