public class AnywhereFolderAPI
extends java.lang.Object
See the method AnywhereAPI.getFolderAPI() to obtain an instance of the AnywhereFolderAPI.
| Modifier and Type | Field and Description |
|---|---|
static boolean |
DEFAULT_CREATE_PARENTS
The default value to use for createParents on
create(com.hds.hcpaw.fss.api.model.AuthToken, String) operations. |
| Modifier | Constructor and Description |
|---|---|
protected |
AnywhereFolderAPI(AnywhereConnector connector) |
| Modifier and Type | Method and Description |
|---|---|
Entry |
create(AuthToken authToken,
java.lang.String path)
Calls
create(com.hds.hcpaw.fss.api.model.AuthToken, String, boolean) with
DEFAULT_CREATE_PARENTS (false) as the value for
createParents. |
Entry |
create(AuthToken authToken,
java.lang.String path,
boolean createParents)
Creates a folder at the specified path.
|
FolderSize |
getSize(AuthToken authToken,
java.lang.String path,
long pointInTime)
Get the size of a folder
|
FolderListing |
listEntries(AuthToken authToken,
java.lang.String path,
java.lang.String pageToken,
int pageSize)
Lists the contents (files and folders) of the specified folder, one "page" at a time.
|
FolderListing |
listEntries(AuthToken authToken,
java.lang.String path,
java.lang.String pageToken,
int pageSize,
FolderListingRequest.SortingCriterion sortingCriterion,
FolderListingRequest.SortingDirection sortingDirection)
Lists the contents (files and folders) of the specified folder, one "page" at a time.
|
FolderListing |
listEntriesAtTime(AuthToken authToken,
java.lang.String path,
java.lang.Long viewAtTime,
java.lang.String pageToken,
int pageSize)
Lists the contents (files and folders) of the specified folder at a specified time, one
"page" at a time.
|
FolderListing |
listEntriesAtTime(AuthToken authToken,
java.lang.String path,
java.lang.Long viewAtTime,
java.lang.String pageToken,
int pageSize,
FolderListingRequest.SortingCriterion sortingCriterion,
FolderListingRequest.SortingDirection sortingDirection)
Lists the contents (files and folders) of the specified folder at a specified time, one
"page" at a time.
|
FolderListing |
listEntriesIncludeDeleted(AuthToken authToken,
java.lang.String path,
java.lang.String pageToken,
int pageSize)
Lists the contents (files and folders) of the specified folder, including deleted entries,
one "page" at a time.
|
FolderListing |
listEntriesIncludeDeleted(AuthToken authToken,
java.lang.String path,
java.lang.String pageToken,
int pageSize,
FolderListingRequest.SortingCriterion sortingCriterion,
FolderListingRequest.SortingDirection sortingDirection)
Lists the contents (files and folders) of the specified folder, including deleted entries,
one "page" at a time.
|
Entry |
restore(AuthToken authToken,
java.lang.String path,
int deltaSeconds)
Restore a folder
|
public static final boolean DEFAULT_CREATE_PARENTS
create(com.hds.hcpaw.fss.api.model.AuthToken, String) operations. Has a value of
false.protected AnywhereFolderAPI(AnywhereConnector connector)
public Entry create(AuthToken authToken, java.lang.String path) throws AwUnsupportedApiVersionException, java.io.IOException, AnywhereException
create(com.hds.hcpaw.fss.api.model.AuthToken, String, boolean) with
DEFAULT_CREATE_PARENTS (false) as the value for
createParents.AwUnsupportedApiVersionExceptionjava.io.IOExceptionAnywhereExceptionpublic Entry create(AuthToken authToken, java.lang.String path, boolean createParents) throws AwUnsupportedApiVersionException, java.io.IOException, AnywhereException
authToken - authentication token for the user performing the requestpath - path (including folder name) where the folder will be createdcreateParents - if true, then any parent folders of path that do not already exist will
be created. If false, then the operation will fail if any parent folders of path
do not existAwUnsupportedApiVersionException - if this method is
not supported by the server due to the server's supported API versionsAwNotFoundException - if the parent of path does not
exist and createParents if falsejava.io.IOExceptionAnywhereExceptionpublic FolderListing listEntries(AuthToken authToken, java.lang.String path, java.lang.String pageToken, int pageSize) throws AwUnsupportedApiVersionException, java.io.IOException, AnywhereException
This method should be called first with a null pageToken. Then, if there are more entries in the folder, subsequent calls should use the pageToken returned from the previous call.
If the last page of entries is returned, then the returned FolderListing will contain a null pageToken.
authToken - authentication token for the user performing the requestpath - path (including folder name) to the folderpageToken - if null, the first page of entries are returned. To return the next page of
entries, use the pageToken that was returned in the previous callpageSize - maximum number of entries to be returnedAwUnsupportedApiVersionException - if this method is
not supported by the server due to the server's supported API versionsAwNotFoundException - if path does not exist or is not
a folderjava.io.IOExceptionAnywhereExceptionpublic FolderListing listEntries(AuthToken authToken, java.lang.String path, java.lang.String pageToken, int pageSize, FolderListingRequest.SortingCriterion sortingCriterion, FolderListingRequest.SortingDirection sortingDirection) throws AwUnsupportedApiVersionException, java.io.IOException, AnywhereException
This method should be called first with a null pageToken. Then, if there are more entries in the folder, subsequent calls should use the pageToken returned from the previous call.
If the last page of entries is returned, then the returned FolderListing will contain a null pageToken.
authToken - authentication token for the user performing the requestpath - path (including folder name) to the folderpageToken - if null, the first page of entries are returned. To return the next page of
entries, use the pageToken that was returned in the previous callpageSize - maximum number of entries to be returnedAwUnsupportedApiVersionException - if this method is
not supported by the server due to the server's supported API versionsAwNotFoundException - if path does not exist or is not
a folderjava.io.IOExceptionAnywhereExceptionpublic FolderListing listEntriesAtTime(AuthToken authToken, java.lang.String path, java.lang.Long viewAtTime, java.lang.String pageToken, int pageSize) throws AwUnsupportedApiVersionException, java.io.IOException, AnywhereException
This method should be called first with a null pageToken. Then, if there are more entries in the folder, subsequent calls should use the pageToken returned from the previous call.
If the last page of entries is returned, then the returned FolderListing will contain a null pageToken.
authToken - authentication token for the user performing the requestpath - path (including folder name) to the folderviewAtTime - The point in time at which to list entries. Defaults to the current time if
null.pageToken - if null, the first page of entries are returned. To return the next page of
entries, use the pageToken that was returned in the previous callpageSize - maximum number of entries to be returnedAwUnsupportedApiVersionException - if this method is
not supported by the server due to the server's supported API versionsAwNotFoundException - if path does not exist or is not
a folderjava.io.IOExceptionAnywhereExceptionpublic FolderListing listEntriesAtTime(AuthToken authToken, java.lang.String path, java.lang.Long viewAtTime, java.lang.String pageToken, int pageSize, FolderListingRequest.SortingCriterion sortingCriterion, FolderListingRequest.SortingDirection sortingDirection) throws AwUnsupportedApiVersionException, java.io.IOException, AnywhereException
This method should be called first with a null pageToken. Then, if there are more entries in the folder, subsequent calls should use the pageToken returned from the previous call.
If the last page of entries is returned, then the returned FolderListing will contain a null pageToken.
authToken - authentication token for the user performing the requestpath - path (including folder name) to the folderviewAtTime - The point in time at which to list entries. Defaults to the current time if
null.pageToken - if null, the first page of entries are returned. To return the next page of
entries, use the pageToken that was returned in the previous callpageSize - maximum number of entries to be returnedsortingCriterion - How the results should be sorted (by NAME, SIZE, or MODIFY_DATE).
Defaults to NAME. Folders always appear first.sortingDirection - In which direction the results should be presented (ASC for ascending
order, DESC for descending order, based on the sorting criterion). Defaults to
ASC.AwUnsupportedApiVersionException - if this method is
not supported by the server due to the server's supported API versionsAwNotFoundException - if path does not exist or is not
a folderjava.io.IOExceptionAnywhereExceptionpublic FolderListing listEntriesIncludeDeleted(AuthToken authToken, java.lang.String path, java.lang.String pageToken, int pageSize) throws AwUnsupportedApiVersionException, java.io.IOException, AnywhereException
This method should be called first with a null pageToken. Then, if there are more entries in the folder, subsequent calls should use the pageToken returned from the previous call.
If the last page of entries is returned, then the returned FolderListing will contain a null pageToken.
authToken - authentication token for the user performing the requestpath - path (including folder name) to the folderpageToken - if null, the first page of entries are returned. To return the next page of
entries, use the pageToken that was returned in the previous callpageSize - maximum number of entries to be returnedAwUnsupportedApiVersionException - if this method is
not supported by the server due to the server's supported API versionsAwNotFoundException - if path does not exist or is not
a folderjava.io.IOExceptionAnywhereExceptionpublic FolderListing listEntriesIncludeDeleted(AuthToken authToken, java.lang.String path, java.lang.String pageToken, int pageSize, FolderListingRequest.SortingCriterion sortingCriterion, FolderListingRequest.SortingDirection sortingDirection) throws AwUnsupportedApiVersionException, java.io.IOException, AnywhereException
This method should be called first with a null pageToken. Then, if there are more entries in the folder, subsequent calls should use the pageToken returned from the previous call.
If the last page of entries is returned, then the returned FolderListing will contain a null pageToken.
authToken - authentication token for the user performing the requestpath - path (including folder name) to the folderpageToken - if null, the first page of entries are returned. To return the next page of
entries, use the pageToken that was returned in the previous callpageSize - maximum number of entries to be returnedsortingCriterion - How the results should be sorted (by NAME, SIZE, or MODIFY_DATE).
Defaults to NAME. Folders always appear first.sortingDirection - In which direction the results should be presented (ASC for ascending
order, DESC for descending order, based on the sorting criterion). Defaults to
ASC.AwUnsupportedApiVersionException - if this method is
not supported by the server due to the server's supported API versionsAwNotFoundException - if path does not exist or is not
a folderjava.io.IOExceptionAnywhereExceptionpublic Entry restore(AuthToken authToken, java.lang.String path, int deltaSeconds) throws AwUnsupportedApiVersionException, java.io.IOException, AnywhereException
authToken - authentication token for the user performing the requestpath - path (including folder name) to the folderdeltaSeconds - max difference in seconds between deletion of folder and deletion of
entries in the folder to restoreAwUnsupportedApiVersionExceptionjava.io.IOExceptionAnywhereExceptionpublic FolderSize getSize(AuthToken authToken, java.lang.String path, long pointInTime) throws AwUnsupportedApiVersionException, java.io.IOException, AnywhereException
authToken - authentication token for the user performing the requestpath - path (including folder name) to the folderpointInTime - time in epoch at which to get the sizeAwUnsupportedApiVersionExceptionjava.io.IOExceptionAnywhereException