| Package | Description |
|---|---|
| com.microsoft.azure.storage.file |
This package contains the storage service file classes.
|
| Modifier and Type | Method and Description |
|---|---|
protected static FileRequestOptions |
FileRequestOptions.applyDefaults(FileRequestOptions options,
CloudFileClient client)
Uses the concurrent request count from the specified client if
null, sets a default value for
everything else, and sets defaults as defined in the parent class. |
protected static FileRequestOptions |
FileRequestOptions.applyDefaults(FileRequestOptions options,
CloudFileClient client,
boolean setStartTime)
Uses the concurrent request count from the specified client if
null, sets a default value for
everything else, and sets defaults as defined in the parent class. |
FileRequestOptions |
CloudFileClient.getDefaultRequestOptions()
Gets the
FileRequestOptions that is used for requests associated with this CloudFileClient |
| Modifier and Type | Method and Description |
|---|---|
protected static FileRequestOptions |
FileRequestOptions.applyDefaults(FileRequestOptions options,
CloudFileClient client)
Uses the concurrent request count from the specified client if
null, sets a default value for
everything else, and sets defaults as defined in the parent class. |
protected static FileRequestOptions |
FileRequestOptions.applyDefaults(FileRequestOptions options,
CloudFileClient client,
boolean setStartTime)
Uses the concurrent request count from the specified client if
null, sets a default value for
everything else, and sets defaults as defined in the parent class. |
void |
CloudFile.clearRange(long offset,
long length,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Clears a range from a file using the specified lease ID, request options, and operation context.
|
void |
CloudFileShare.create(FileRequestOptions options,
OperationContext opContext)
Creates the share using the specified options and operation context.
|
void |
CloudFileDirectory.create(FileRequestOptions options,
OperationContext opContext)
Creates the directory using the specified options and operation context.
|
void |
CloudFile.create(long size,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Creates a file using the specified access condition, request options and operation context.
|
boolean |
CloudFileShare.createIfNotExists(FileRequestOptions options,
OperationContext opContext)
Creates the share if it does not exist, using the specified request options and operation context.
|
boolean |
CloudFileDirectory.createIfNotExists(FileRequestOptions options,
OperationContext opContext)
Creates the directory if it does not exist, using the specified request options and operation context.
|
void |
CloudFileShare.delete(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Deletes the share using the specified request options and operation context.
|
void |
CloudFileDirectory.delete(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Deletes the directory using the specified request options and operation context.
|
void |
CloudFile.delete(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Deletes the file using the specified access condition, request options, and operation context.
|
boolean |
CloudFileShare.deleteIfExists(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Deletes the share if it exists using the specified request options and operation context.
|
boolean |
CloudFileDirectory.deleteIfExists(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Deletes the directory if it exists using the specified request options and operation context.
|
boolean |
CloudFile.deleteIfExists(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Deletes the file if it exists, using the specified access condition, request options, and operation context.
|
void |
CloudFile.download(OutputStream outStream,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Downloads the contents of a file to a stream using the specified request options and operation context.
|
void |
CloudFileShare.downloadAttributes(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Downloads the share's attributes, which consist of metadata and properties, using the specified request
options and operation context.
|
void |
CloudFileDirectory.downloadAttributes(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Downloads the directory's properties using the specified request options and operation context.
|
void |
CloudFile.downloadAttributes(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Populates a file's properties and metadata using the specified request options and operation context.
|
ArrayList<FileRange> |
CloudFile.downloadFileRanges(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Returns a collection of file ranges and their starting and ending byte offsets using the specified request
options and operation context.
|
void |
CloudFile.downloadRange(long offset,
Long length,
OutputStream outStream,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Downloads the contents of a file to a stream using the specified request options and operation context.
|
protected int |
CloudFile.downloadRangeInternal(long fileOffset,
Long length,
byte[] buffer,
int bufferOffset,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Downloads a range of bytes from the file to the given byte buffer.
|
int |
CloudFile.downloadRangeToByteArray(long offset,
Long length,
byte[] buffer,
int bufferOffset,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Downloads a range of bytes from the file to the given byte buffer, using the specified request options and
operation context.
|
String |
CloudFile.downloadText(String charsetName,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Downloads a file to a string using the specified encoding.
|
int |
CloudFile.downloadToByteArray(byte[] buffer,
int bufferOffset,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Downloads a range of bytes from the file to the given byte buffer, using the specified request options and
operation context.
|
void |
CloudFile.downloadToFile(String path,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Downloads a file.
|
boolean |
CloudFileShare.exists(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Returns a value that indicates whether the share exists, using the specified request options and operation
context.
|
boolean |
CloudFileDirectory.exists(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Returns a value that indicates whether the directory exists, using the specified request options and operation
context.
|
boolean |
CloudFile.exists(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Checks to see if the file exists, using the specified access condition, request options and operation context.
|
Iterable<ListFileItem> |
CloudFileDirectory.listFilesAndDirectories(FileRequestOptions options,
OperationContext opContext)
Returns an enumerable collection of file and directory items for the directory.
|
ResultSegment<ListFileItem> |
CloudFileDirectory.listFilesAndDirectoriesSegmented(Integer maxResults,
ResultContinuation continuationToken,
FileRequestOptions options,
OperationContext opContext)
Returns a result segment of an enumerable collection of files and directories for this directory, using the
specified listing details options, request options, and operation context.
|
Iterable<CloudFileShare> |
CloudFileClient.listShares(String prefix,
ShareListingDetails detailsIncluded,
FileRequestOptions options,
OperationContext opContext)
Returns an enumerable collection of shares whose names begin with the specified prefix for this File
service client, using the specified details settings, request options, and operation context.
|
ResultSegment<CloudFileShare> |
CloudFileClient.listSharesSegmented(String prefix,
ShareListingDetails detailsIncluded,
Integer maxResults,
ResultContinuation continuationToken,
FileRequestOptions options,
OperationContext opContext)
Returns a result segment of an enumerable collection of shares whose names begin with the specified
prefix, using the specified listing details options, request options, and operation context.
|
FileInputStream |
CloudFile.openRead(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Opens a file input stream to download the file using the specified request options and operation context.
|
FileOutputStream |
CloudFile.openWriteExisting(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Opens an output stream object to write data to the file, using specified request options and
operation context.
|
FileOutputStream |
CloudFile.openWriteNew(long length,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Opens an output stream object to write data to the file, using the specified lease ID, request options and
operation context.
|
void |
CloudFile.resize(long size,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Resizes the file to the specified size.
|
void |
CloudFileClient.setDefaultRequestOptions(FileRequestOptions defaultRequestOptions)
Sets the
FileRequestOptions that is used for any requests associated with this
CloudFileClient object. |
void |
CloudFile.upload(InputStream sourceStream,
long length,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Uploads the source stream data to the file using the specified access condition, request options, and operation
context.
|
void |
CloudFile.uploadFromByteArray(byte[] buffer,
int offset,
int length,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Uploads a file from data in a byte array.
|
void |
CloudFile.uploadFromFile(String path,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Uploads a file from a file.
|
void |
CloudFileShare.uploadMetadata(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Uploads the share's metadata using the specified request options and operation context.
|
void |
CloudFile.uploadMetadata(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Uploads the file's metadata to the storage service using the access condition, request options, and operation
context.
|
void |
CloudFile.uploadProperties(AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Updates the file's properties using the access condition, request options, and operation context.
|
void |
CloudFile.uploadRange(InputStream sourceStream,
long offset,
long length,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Uploads a range to a file using the specified lease ID, request options, and operation context.
|
void |
CloudFile.uploadText(String content,
String charsetName,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Uploads a file from a string using the specified encoding.
|
| Constructor and Description |
|---|
FileInputStream(CloudFile parentFile,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Initializes a new instance of the FileInputStream class.
|
FileOutputStream(CloudFile parentFile,
long length,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext opContext)
Initializes a new instance of the FileOutputStream class.
|
FileRequestOptions(FileRequestOptions other)
Creates an instance of the
FileRequestOptions class by copying values from another
FileRequestOptions instance. |
/**
* Copyright Microsoft Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/