* This method is used to find datasets available for searching. By passing no parameters except node, all available datasets are returned.
* Additional parameters such as temporal range and spatial bounding box can be used to find datasets that provide more specific data.
* The dataset name parameter can be used to limit the results based on matching the supplied value against the public dataset name with
* assumed wildcards at the beginning and end.
* This method is used to find datasets available for searching. By passing only API Key, all available datasets are returned. Additional parameters such as temporal range and
* spatial bounding box can be used to find datasets that provide more specific data. The dataset name parameter can be used to limit the results based on matching the supplied
* value against the public dataset name with assumed wildcards at the beginning and end.
*
* @author Daniel Eggert (daniel.eggert@gfz-potsdam.de)
*
...
...
@@ -26,13 +25,14 @@ public class DatasetSearchRequest extends AbstractSearchRequest<DatasetSearchRes
privateBooleanpublicOnly=null;
/**
* @param code
* Ctor
*
* @param apiKey
* - api key string acquired via {@link LoginRequest}
* The download request is used to generate a list of direct download URL's for data. To get available products, submit a downloadOptions request. All unavailable or invalid
* products are automatically excluded from the response.<br>
* <br>
* This request implements a rate limit on unattempted downloads. Download authorization records are created as a result of this request with the intent that the user will download
* the data before submitting subsequent requests. The rate limit is defined by 10 unattampted downloads within the last 10 minutes.
* products are automatically excluded from the response.
*
* This request implements a rate limit based on a limit of 10 downloads that have not been completed within the last 15 minutes.
*
* @author Daniel Eggert (daniel.eggert@gfz-potsdam.de)
*
...
...
@@ -39,6 +39,21 @@ public class DownloadRequest extends JSONRequest<DownloadResponse> {
privatefinalStringdataUse;
privatefinalbooleanstage;
/**
*
* @param apiKey
* - api key string acquired via {@link LoginRequest}
* @param datasetName
* - name of the dataset, e.g. obtained from {@link DatasetSearchRequest}, like LANDSAT_8_C1
* @param entityIds
* - array of entityids the download urls will be obtained for
* @param products
* - array of product names for each entityid (see {@link DownloadOptionsResponse})
* @param dataUse
* - Used to identify higher level products that this data may be used to create
* @param stage
* - If <code>true</code>, initiates a data stage command
* Represents a hits request, returning the number of expected hits.<br>
* <br>
* This method is used in determining the number of hits a search returns.
* Because a hits request requires a search, this request takes the same parameters as the search request,
* This method is used in determining the number of hits a search returns. Because a hits request requires a search, this request takes the same parameters as the search request,
* with exception to the non-search-field parameters; maxResults, startingNumber, and sortOrder.
*
* @author Daniel Eggert (daniel.eggert@gfz-potsdam.de)
...
...
@@ -24,11 +21,17 @@ public class HitsRequest extends AbstractFilteredSearchRequest<HitsResponse> {
/**
*
* @param apiKey
* - api key string acquired via {@link LoginRequest}
* @param datasetName
* - name of the dataset, e.g. obtained from {@link DatasetSearchRequest}, like LANDSAT_8_C1
* @param temporalFilter
* - temporal filter range
* @param spatialFilter
* - spatial filter range
* @param filter
* - additional filters
* @param includeUnknownCloudCover
* - flag for also include scenes with unknown cloud cover
* Represents a login request holding the user credentials
* Upon a successful login, an API key will be returned. This key will be active for one hour and should be destroyed upon final use of the service by calling the logout method.
*
* This request requires an HTTP POST request instead of a HTTP GET request as a security measure to prevent username and password information from being logged by firewalls, web
* servers, etc.
*
* @author Daniel Eggert (daniel.eggert@gfz-potsdam.de)
*
...
...
@@ -27,6 +30,18 @@ public class LoginRequest extends JSONRequest<LoginResponse> {
* Represents a hits request, returning the number of expected hits.<br>
* <br>
* Searching is done with limited search criteria. All coordinates are assumed decimal-degree format. If lowerLeft or upperRight are supplied, then both must exist in the request
* to complete the bounding box. Starting and ending dates, if supplied, are used as a range to search data based on acquisition dates. The current implementation will only search
* at the date level, discarding any time information. If data in a given dataset is composite data, or data acquired over multiple days, a search will be done to match any
* intersection of the acquisition range. There currently is a 50,000 scene limit for the number of results that are returned, however, some client applications may encounter
* timeouts for large result sets for some datasets.
* timeouts for large result sets for some datasets.<br>
* <br>
* To use the additional criteria field, pass one of the four search filter objects (SearchFilterAnd, SearchFilterBetween, SearchFilterOr, SearchFilterValue) in JSON format with
* additionalCriteria being the root element of the object.
*
*
* @author Daniel Eggert (daniel.eggert@gfz-potsdam.de)
...
...
@@ -36,11 +37,17 @@ public class SceneSearchRequest extends AbstractFilteredSearchRequest<SceneSearc
/**
*
* @param apiKey
* - api key string acquired via {@link LoginRequest}
* @param datasetName
* - name of the dataset, e.g. obtained from {@link DatasetSearchRequest}, like LANDSAT_8_C1
* @param temporalFilter
* - temporal filter range
* @param spatialFilter
* - spatial filter range
* @param filter
* - additional filters
* @param includeUnknownCloudCover
* - flag for also include scenes with unknown cloud cover
