com.postalocity.resteasy2.request

Class AddSourceRequest

java.lang.Object

com.postalocity.resteasy2.request.AddSourceRequest

public class AddSourceRequest
extends java.lang.Object

Created by lewisayers on 12/28/16.

Field Summary

Fields

Modifier and Type	Field and Description
Address	deliveryAddress
java.lang.Integer	jobId
java.lang.String	uploadedFileName
java.lang.String	uploadUrl

Constructor Summary

Constructors

Constructor and Description
AddSourceRequest()

Method Summary

Modifier and Type	Method and Description
Address	getDeliveryAddress()
java.lang.Integer	getJobId()
java.lang.String	getUploadedFileName()
java.lang.String	getUploadUrl()
boolean	isValid()
void	setDeliveryAddress(Address deliveryAddress) This is where you can supply the delivery address.
void	setJobId(java.lang.Integer jobId) Used to reference the job this source will be attached.
void	setUploadedFileName(java.lang.String uploadedFileName) If the source file has already been uploaded, provide the name of that file here so that the provided delivery address can be attached.
void	setUploadUrl(java.lang.String uploadUrl) The uploadUrl is a publicly available url for the source file provided.

Methods inherited from class java.lang.Object

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

Field Detail

jobId

public java.lang.Integer jobId

uploadUrl

public java.lang.String uploadUrl

uploadedFileName

public java.lang.String uploadedFileName

deliveryAddress

public Address deliveryAddress

Constructor Detail

AddSourceRequest

public AddSourceRequest()

Method Detail

getJobId

public java.lang.Integer getJobId()

setJobId

public void setJobId(java.lang.Integer jobId)

Used to reference the job this source will be attached. This field is required.

Parameters:

jobId - id of job

getUploadUrl

public java.lang.String getUploadUrl()

setUploadUrl

public void setUploadUrl(java.lang.String uploadUrl)

The uploadUrl is a publicly available url for the source file provided. If this parameter is set, the url will be called and the file downloaded to the source directory of the provided job.

Ex. https://mydomain.com/MyFantasticFile.pdf

Note: This can be a pre-signed url.

Parameters:

uploadUrl - publicly available url to source file

getUploadedFileName

public java.lang.String getUploadedFileName()

setUploadedFileName

public void setUploadedFileName(java.lang.String uploadedFileName)

If the source file has already been uploaded, provide the name of that file here so that the provided delivery address can be attached.

Ex. MyFantasticFile.pdf

Parameters:

uploadedFileName - name of uploaded file

getDeliveryAddress

public Address getDeliveryAddress()

setDeliveryAddress

public void setDeliveryAddress(Address deliveryAddress)

This is where you can supply the delivery address. Use this if you do not want to provide the address via text extraction or CSV reference. If this address is not provided, an attempt to extract the address from the document will be made.

Parameters:

deliveryAddress - address object to be associated with this source document

isValid

public boolean isValid()