Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,9 @@ public DirectoryAsyncClient getSubDirectoryClient(String subDirectoryName) {
*
* {@codesnippet com.azure.storage.file.directoryAsyncClient.create}
*
* <p>For more information, see the
* <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory">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.
*/
Expand All @@ -157,6 +160,9 @@ public Mono<Response<DirectoryInfo>> create() {
*
* {@codesnippet com.azure.storage.file.directoryAsyncClient.create#map}
*
* <p>For more information, see the
* <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory">Azure Docs</a>.</p>
*
* @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.
Expand All @@ -175,6 +181,9 @@ public Mono<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
*/
Expand All @@ -193,6 +202,9 @@ public Mono<VoidResponse> delete() {
*
* {@codesnippet com.azure.storage.file.directoryAsyncClient.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 Mono<Response<DirectoryProperties>> getProperties() {
Expand All @@ -215,6 +227,9 @@ public Mono<Response<DirectoryProperties>> getProperties() {
*
* {@codesnippet com.azure.storage.file.directoryAsyncClient.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
Expand All @@ -233,6 +248,9 @@ public Mono<Response<DirectorySetMetadataInfo>> setMetadata(Map<String, String>
*
* {@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 Flux<FileRef> listFilesAndDirectories() {
Expand All @@ -248,6 +266,9 @@ public Flux<FileRef> listFilesAndDirectories() {
*
* {@codesnippet com.azure.storage.file.directoryAsyncClient.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.
Expand All @@ -267,6 +288,9 @@ public Flux<FileRef> listFilesAndDirectories(String prefix, Integer maxResults)
*
* {@codesnippet com.azure.storage.file.directoryAsyncClient.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
Expand All @@ -287,6 +311,9 @@ public Flux<HandleItem> getHandles(Integer maxResult, boolean recursive) {
*
* {@codesnippet com.azure.storage.file.directoryAsyncClient.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
Expand All @@ -305,6 +332,9 @@ public Flux<Integer> forceCloseHandles(String handleId, boolean recursive) {
*
* {@codesnippet com.azure.storage.file.directoryAsyncClient.createSubDirectory#string}
*
* <p>For more information, see the
* <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory">Azure Docs</a>.</p>
*
* @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.
Expand All @@ -322,6 +352,9 @@ public Mono<Response<DirectoryAsyncClient>> createSubDirectory(String subDirecto
*
* {@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/create-directory">Azure Docs</a>.</p>
*
* @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.
Expand All @@ -342,6 +375,9 @@ public Mono<Response<DirectoryAsyncClient>> createSubDirectory(String subDirecto
*
* {@codesnippet com.azure.storage.file.directoryAsyncClient.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.
Expand All @@ -360,6 +396,9 @@ public Mono<VoidResponse> deleteSubDirectory(String subDirectoryName) {
*
* {@codesnippet com.azure.storage.file.directoryAsyncClient.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 FileAsyncClient and the status of creating the directory.
Expand All @@ -378,6 +417,9 @@ public Mono<Response<FileAsyncClient>> createFile(String fileName, long maxSize)
*
* {@codesnippet com.azure.storage.file.directoryAsyncClient.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
Expand All @@ -399,6 +441,9 @@ public Mono<Response<FileAsyncClient>> createFile(String fileName, long maxSize,
*
* {@codesnippet com.azure.storage.file.directoryAsyncClient.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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/create-directory">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.
*/
Expand All @@ -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/create-directory">Azure Docs</a>.</p>
*
* @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.
Expand All @@ -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
*/
Expand All @@ -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() {
Expand All @@ -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
Expand All @@ -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() {
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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.
Expand All @@ -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/create-directory">Azure Docs</a>.</p>
*
* @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.
Expand All @@ -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/create-directory">Azure Docs</a>.</p>
*
* @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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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.
Expand Down
Loading