-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Added REST API link in file JAVA doc #4568
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 14 commits
1ec9438
78db8d4
69026ba
be429c3
b00cdc6
da7ebb6
78ea66b
44fb56e
fe9559f
53b2854
2f88e9c
165e16a
8b8ec82
ed97215
238dec7
81721cb
ef3b376
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -91,6 +91,9 @@ public DirectoryClient getSubDirectoryClient(String subDirectoryName) { | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.createDirectory} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/list-directories-and-files">Azure Docs</a>.</p> | ||
| * | ||
| * @return A response containing the directory info and the status of creating the directory. | ||
| * @throws StorageErrorException If the directory has already existed, the parent directory does not exist or directory name is an invalid resource name. | ||
| */ | ||
|
|
@@ -107,6 +110,9 @@ public Response<DirectoryInfo> create() { | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.create#map} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/list-directories-and-files">Azure Docs</a>.</p> | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Incorrect link #Resolved
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done. #Resolved |
||
| * | ||
| * @param metadata Optional metadata to associate with the directory. | ||
| * @return A response containing the directory info and the status of creating the directory. | ||
| * @throws StorageErrorException If the directory has already existed, the parent directory does not exist or directory name is an invalid resource name. | ||
|
|
@@ -124,6 +130,9 @@ public Response<DirectoryInfo> create(Map<String, String> metadata) { | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.delete} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory">Azure Docs</a>.</p> | ||
| * | ||
| * @return A response that only contains headers and response status code | ||
| * @throws StorageErrorException If the share doesn't exist | ||
| */ | ||
|
|
@@ -141,6 +150,9 @@ public VoidResponse delete() { | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.getProperties} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/get-directory-properties">Azure Docs</a>.</p> | ||
| * | ||
| * @return Storage directory properties | ||
| */ | ||
| public Response<DirectoryProperties> getProperties() { | ||
|
|
@@ -162,6 +174,9 @@ public Response<DirectoryProperties> getProperties() { | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.setMetadata#map.clearMetadata} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/set-directory-metadata">Azure Docs</a>.</p> | ||
| * | ||
| * @param metadata Optional metadata to set on the directory, if null is passed the metadata for the directory is cleared | ||
| * @return information about the directory | ||
| * @throws StorageErrorException If the directory doesn't exist or the metadata contains invalid keys | ||
|
|
@@ -179,6 +194,9 @@ public Response<DirectorySetMetadataInfo> setMetadata(Map<String, String> metada | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.listFilesAndDirectories} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/list-directories-and-files">Azure Docs</a>.</p> | ||
| * | ||
| * @return {@link FileRef File info} in the storage directory | ||
| */ | ||
| public Iterable<FileRef> listFilesAndDirectories() { | ||
|
|
@@ -194,6 +212,9 @@ public Iterable<FileRef> listFilesAndDirectories() { | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.listFilesAndDirectories#string-integer} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/list-directories-and-files">Azure Docs</a>.</p> | ||
| * | ||
| * @param prefix Optional prefix which filters the results to return only files and directories whose name begins with. | ||
| * @param maxResults Optional maximum number of files and/or directories to return per page. | ||
| * If the request does not specify maxresults or specifies a value greater than 5,000, the server will return up to 5,000 items. | ||
|
|
@@ -212,6 +233,9 @@ public Iterable<FileRef> listFilesAndDirectories(String prefix, Integer maxResul | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.getHandles} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/list-handles">Azure Docs</a>.</p> | ||
| * | ||
| * @param maxResult Optional maximum number of results will return per page | ||
| * @param recursive Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. | ||
| * @return {@link HandleItem handles} in the directory that satisfy the requirements | ||
|
|
@@ -231,6 +255,9 @@ public Iterable<HandleItem> getHandles(Integer maxResult, boolean recursive) { | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.forceCloseHandles} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles">Azure Docs</a>.</p> | ||
| * | ||
| * @param handleId Specifies the handle ID to be closed. Use an asterisk ('*') as a wildcard string to specify all handles. | ||
| * @param recursive A boolean value that specifies if the operation should also apply to the files and subdirectories of the directory specified in the URI. | ||
| * @return The counts of number of handles closed. | ||
|
|
@@ -248,6 +275,9 @@ public Iterable<Integer> forceCloseHandles(String handleId, boolean recursive) { | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.createSubDirectory#string} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/list-directories-and-files">Azure Docs</a>.</p> | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Incorrect link #Resolved
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done. #Resolved |
||
| * | ||
| * @param subDirectoryName Name of the subdirectory | ||
| * @return A response containing the subdirectory client and the status of creating the directory. | ||
| * @throws StorageErrorException If the subdirectory has already existed, the parent directory does not exist or directory is an invalid resource name. | ||
|
|
@@ -265,6 +295,9 @@ public Response<DirectoryClient> createSubDirectory(String subDirectoryName) { | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.createSubDirectory#string-map} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/list-directories-and-files">Azure Docs</a>.</p> | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
incorrect link #Resolved
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done. #Resolved |
||
| * | ||
| * @param subDirectoryName Name of the subdirectory | ||
| * @param metadata Optional metadata to associate with the subdirectory | ||
| * @return A response containing the subdirectory client and the status of creating the directory. | ||
|
|
@@ -284,6 +317,9 @@ public Response<DirectoryClient> createSubDirectory(String subDirectoryName, Map | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.deleteSubDirectory#string} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory">Azure Docs</a>.</p> | ||
| * | ||
| * @param subDirectoryName Name of the subdirectory | ||
| * @return A response that only contains headers and response status code | ||
| * @throws StorageErrorException If the subdirectory doesn't exist, the parent directory does not exist or subdirectory name is an invalid resource name. | ||
|
|
@@ -301,6 +337,9 @@ public VoidResponse deleteSubDirectory(String subDirectoryName) { | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.createFile#string-long} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/create-file">Azure Docs</a>.</p> | ||
| * | ||
| * @param fileName Name of the file | ||
| * @param maxSize Size of the file | ||
| * @return A response containing the FileClient and the status of creating the directory. | ||
|
|
@@ -319,6 +358,9 @@ public Response<FileClient> createFile(String fileName, long maxSize) { | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.createFile#string-long-fileHTTPHeaders-map} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/create-file">Azure Docs</a>.</p> | ||
| * | ||
| * @param fileName Name of the file | ||
| * @param maxSize Max size of the file | ||
| * @param httpHeaders the Http headers set to the file | ||
|
|
@@ -340,6 +382,9 @@ public Response<FileClient> createFile(String fileName, long maxSize, FileHTTPHe | |
| * | ||
| * {@codesnippet com.azure.storage.file.directoryClient.deleteFile#string} | ||
| * | ||
| * <p>For more information, see the | ||
| * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2">Azure Docs</a>.</p> | ||
| * | ||
| * @param fileName Name of the file | ||
| * @return A response that only contains headers and response status code | ||
| * @throws StorageErrorException If the directory doesn't exist or the file doesn't exist or file name is an invalid resource name. | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Incorrect link #Resolved
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done with the checking for the entire file. #Resolved