public interface RecycleBinQueryService
Modifier and Type | Method and Description |
---|---|
String |
executeRecycleBinContainerQuery(RecycleBinContainerQuery query,
ExtractFileCreateInfo file)
Extracts individual containers that have been deleted and reside in a recycle bin based on the specified query.
|
String |
executeRecycleBinFileQuery(RecycleBinFileQuery query,
ExtractFileCreateInfo file)
Extracts individual files that have been deleted and reside in a recycle bin based on the specified query.
|
String |
executeRecycleBinFileVersionQuery(RecycleBinFileVersionQuery query,
ExtractFileCreateInfo file)
Extracts individual files that have been deleted and reside in a recycle bin based on the specified query.
|
String |
executeRecycleBinItemQuery(RecycleBinItemQuery query,
ExtractFileCreateInfo file)
Extracts individual items that have been deleted and reside in a recycle bin based on the specified query.
|
String executeRecycleBinItemQuery(RecycleBinItemQuery query, ExtractFileCreateInfo file) throws QueryException
QueryLimitException
will be thrown.
*
Here is an example of how to query recycle items for any item deleted in a specific location within the last month. The output will include all available RecycleBinItemQuery columns and will be sorted in ascending order (oldest first) by date deleted.
RecycleBinItemQuery query = new RecycleBinItemQuery(); Date oneMonthAgo = DateUtils.addMonths(new Date(), -1); query.select(RecycleBinItemQuery.ALL) .constrain(Condition.and(Comparison.greaterThan(RecycleBinItemQuery.DELETED_DATE, oneMonthAgo.getTime()), Comparison.like(RecycleBinItemQuery.PATH, "/ORG/PROJECT_A/*"))) .order(Order.ascending(RecycleBinItemQuery.DELETED_DATE)); service.executeRecycleBinItemQuery(query, fileInfo);
query
- The recycle bin criteria with which to query the recycle bin content.file
- The method to add the query output file.QueryException
- Thrown when there is an issue generating the query.String executeRecycleBinContainerQuery(RecycleBinContainerQuery query, ExtractFileCreateInfo file) throws QueryException
RecycleBinContainerQuery
represents total
size of all files in that container and below including all versions of the file if it is versioned. The method
requires the current user be an administrative mode user. If the query results in more than one million records,
a QueryLimitException
will be thrown.
*
Here is an example of how to query recycle bin containers whose size is greater than 1 million bytes (roughly 1 gigabyte). Size represents the total size including all versions of all files in the container and below. The output will include path and size columns and will sort according to size using the default sort order which is descending.
RecycleBinContainerQuery query = new RecycleBinContainerQuery(); query.select(RecycleBinItemQuery.PATH, RecycleBinContainerQuery.SIZE) .constrain(Comparison.greaterThan(RecycleBinContainerQuery.SIZE, 1000000)); .order((RecycleBinContainerQuery.SIZE)); service.executeRecycleBinContainerQuery(query, fileInfo);
query
- The recycle bin criteria with which to query the recycle bin content.file
- The method to add the query output file.QueryException
- Thrown when there is an issue generating the query.String executeRecycleBinFileQuery(RecycleBinFileQuery query, ExtractFileCreateInfo file) throws QueryException
QueryLimitException
will be thrown.
Here is an example of how to query recycle bin files that are SAS data sets and have greater than 10 versions. The output will include all available RecycleBinFileQuery columns and will sort according to number of versions using the default sort order which is descending.
RecycleBinFileQuery query = new RecycleBinFileQuery(); query.select(RecycleBinFileQuery.ALL); query.constrain(Condition.and(Comparison.equal(RecycleBinItemQuery.TYPE_ID, TypeConstants.TYPE_SAS_DATASET), Comparison.greaterThan(RecycleBinFileQuery.TOTAL_VERSIONS, 10))); query.order(RecycleBinFileQuery.TOTAL_VERSIONS); service.executeRecycleBinFileQuery(query, fileInfo);
query
- The recycle bin criteria with which to query the recycle bin content.file
- The method to add the query output file.QueryException
- Thrown when there is an issue generating the query.String executeRecycleBinFileVersionQuery(RecycleBinFileVersionQuery query, ExtractFileCreateInfo file) throws QueryException
QueryLimitException
will be thrown.
* Here is an example of how to query recycle bin files that have a specific version whose size is greater than 10000000 bytes (roughly 10 megabytes). The output will include path, version, and size columns and will be sorted in descending order by size.
RecycleBinFileVersionQuery query = new RecycleBinFileVersionQuery(); query.select(RecycleBinItemQuery.PATH, RecycleBinFileVersionQuery.VERSION, RecycleBinFileVersionQuery.SIZE); query.constrain(Comparison.greaterThanOrEqual(RecycleBinFileVersionQuery.SIZE, 10000000)); query.order(Order.descending(RecycleBinFileVersionQuery.SIZE)); service.executeRecycleBinFileVersionQuery(query, fileInfo);
query
- The recycle bin criteria with which to query the recycle bin content.file
- The method to add the query output file.QueryException
- Thrown when there is an issue generating the query.Copyright (c) 2020, SAS Institute Inc., Cary, NC, USA