Package org.gbif.api.model.occurrence
Class DownloadRequest
java.lang.Object
org.gbif.api.model.occurrence.DownloadRequest
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
PredicateDownloadRequest
,SqlDownloadRequest
Represents a request to download occurrence records.
This is the base class for specific type of downloads: predicate based downloads and SQL downloads.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.DownloadRequest
(String creator, Collection<String> notificationAddresses, Boolean sendNotification, DownloadFormat format, DownloadType downloadType, String description, com.fasterxml.jackson.databind.JsonNode machineDescription) -
Method Summary
Modifier and TypeMethodDescriptionboolean
com.fasterxml.jackson.databind.JsonNode
Returns the notification addresses as single string.getType()
int
hashCode()
void
setCreator
(String creator) void
setDescription
(String description) void
setFormat
(DownloadFormat format) This parameter determines the output format of the requested download.void
setMachineDescription
(com.fasterxml.jackson.databind.JsonNode machineDescription) void
setNotificationAddresses
(Set<String> notificationAddresses) void
setNotificationAddressesAsString
(String notificationAddressesAsString) Sets the notificationAddresses using a single String value that is split by ','.void
setSendNotification
(boolean sendNotification) This parameter determines if the requested download must be notified to the created once it's ready.void
setType
(DownloadType type) Download type: Occurrence or Event.toString()
-
Constructor Details
-
DownloadRequest
public DownloadRequest()Default constructor. -
DownloadRequest
public DownloadRequest(String creator, Collection<String> notificationAddresses, Boolean sendNotification, DownloadFormat format, DownloadType downloadType, String description, com.fasterxml.jackson.databind.JsonNode machineDescription)
-
-
Method Details
-
getCreator
- Returns:
- the user account that initiated the download
-
setCreator
-
getNotificationAddresses
- Returns:
- set of email addresses for notifications
-
setNotificationAddresses
-
getNotificationAddressesAsString
Returns the notification addresses as single string. The emails are separated by ','. -
setNotificationAddressesAsString
Sets the notificationAddresses using a single String value that is split by ','. -
getSendNotification
-
setSendNotification
This parameter determines if the requested download must be notified to the created once it's ready. -
getFormat
-
setFormat
This parameter determines the output format of the requested download. -
getType
-
setType
Download type: Occurrence or Event. -
getDescription
-
setDescription
-
getMachineDescription
-
setMachineDescription
-
getFileExtension
-
equals
-
hashCode
-
toString
-