Package com.pdfgate

Class UploadFileParams

java.lang.Object

com.pdfgate.UploadFileParams

public final class UploadFileParams
extends Object

Parameters for uploading a raw PDF file or URL to PDFGate.

Provide either file or url. If file is provided, it is prioritized and sent as multipart form data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UploadFileParams.Builder	Builder for UploadFileParams.

Method Summary

Modifier and Type	Method	Description
static UploadFileParams.Builder	builder()	Creates a new builder for upload file parameters.
FileParam	getFile()	Returns the file payload to upload, if provided.
Object	getMetadata()	Returns metadata to attach to the document.
Long	getPreSignedUrlExpiresIn()	Returns the pre-signed URL expiration time in seconds, if provided.
String	getUrl()	Returns the URL to upload, if provided.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static UploadFileParams.Builder builder()

Creates a new builder for upload file parameters.

Returns:

the builder for upload file parameters.

getFile

public FileParam getFile()

Returns the file payload to upload, if provided.

Returns:

the file payload to upload, if provided.

getUrl

public String getUrl()

Returns the URL to upload, if provided.

Returns:

the URL to upload, if provided.

getMetadata

public Object getMetadata()

Returns metadata to attach to the document.

Returns:

metadata to attach to the document.

getPreSignedUrlExpiresIn

public Long getPreSignedUrlExpiresIn()

Returns the pre-signed URL expiration time in seconds, if provided.

Returns:

the pre-signed URL expiration time in seconds, if provided.