C# Class azurecopy.AzureFileHandler

Inheritance: IBlobHandler

Show file Open project: kpfaulkner/azurecopy Class Usage Examples

Public Methods

Method	Description
AzureFileHandler ( string url ) : System	base url HAS to be passed in.
GetBaseUrl ( ) : string
GetBlobNameFromUrl ( string url ) : string	Gets blob name from the full url. This is cloud specific.
GetContainer ( string url ) : Microsoft.WindowsAzure.Storage.File.CloudFileDirectory
GetContainerNameFromUrl ( string url ) : string	Gets container name from the full url. This is cloud specific.
ListBlobsInContainer ( string containerName = null, string blobPrefix = null, bool debug = false ) : IEnumerable	Lists all blobs in a container. Can be supplied a blobPrefix which basically acts as virtual directory options. eg, if we have blobs called: "virt1/virt2/myblob" and "virt1/virt2/myblob2" Although the blob names are the complete strings mentioned above, we might like to think that the blobs are just called myblob and myblob2. We can supply a blobPrefix of "virt1/virt2/" which we can think of as a directory, but again, its just really a prefix behind the scenes. For other sytems (not Azure) the blobPrefix might be real directories.... will need to investigate
ListContainers ( string root ) : List	List containers/directories off the root. For storage schemes that allow real directories maybe the root will be
MakeContainer ( string containerName ) : void	Make container/directory (depending on platform).
MoveBlob ( string originContainer, string destinationContainer, string startBlobname ) : void	Move blob
OverrideConfiguration ( string>.Dictionary configuration ) : void
ReadBlob ( string containerName, string blobName, string cacheFilePath = "" ) : Blob	Read blob.
ReadBlobSimple ( string container, string blobName, string filePath = "" ) : Blob
WriteBlob ( string containerName, string blobName, Blob blob, int parallelUploadFactor = 1, int chunkSizeInMB = 4 ) : void	Write blob

Private Methods

Method	Description
ParallelWriteBlockBlob ( Stream stream, Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob blob, int parallelFactor, int chunkSizeInMB ) : void	Upload in parallel. If total size of file is smaller than chunkSize, then simply split length by parallel factor.
ReadBlockBlob ( ICloudBlob blobRef, string fileName = "" ) : Blob
ReadPageBlob ( ICloudBlob blobRef, string fileName = "" ) : Blob
WriteBlockBlob ( Stream stream, Blob blob, Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer container, int parallelFactor = 1, int chunkSizeInMB = 2 ) : void
WritePageBlob ( Stream stream, Blob blob, Microsoft.WindowsAzure.Storage.Blob.CloudBlobContainer container, int parallelFactor = 1, int chunkSizeInMB = 2 ) : void

Method Details

AzureFileHandler() public method

base url HAS to be passed in.

public AzureFileHandler ( string url ) : System
url	string
return	System

GetBaseUrl() public method

public GetBaseUrl ( ) : string
return	string

GetBlobNameFromUrl() public method

Gets blob name from the full url. This is cloud specific.

public GetBlobNameFromUrl ( string url ) : string
url	string
return	string

GetContainer() public method

public GetContainer ( string url ) : Microsoft.WindowsAzure.Storage.File.CloudFileDirectory
url	string
return	Microsoft.WindowsAzure.Storage.File.CloudFileDirectory

GetContainerNameFromUrl() public method

Gets container name from the full url. This is cloud specific.

public GetContainerNameFromUrl ( string url ) : string
url	string
return	string

ListBlobsInContainer() public method

Lists all blobs in a container. Can be supplied a blobPrefix which basically acts as virtual directory options. eg, if we have blobs called: "virt1/virt2/myblob" and "virt1/virt2/myblob2" Although the blob names are the complete strings mentioned above, we might like to think that the blobs are just called myblob and myblob2. We can supply a blobPrefix of "virt1/virt2/" which we can *think* of as a directory, but again, its just really a prefix behind the scenes. For other sytems (not Azure) the blobPrefix might be real directories.... will need to investigate

public ListBlobsInContainer ( string containerName = null, string blobPrefix = null, bool debug = false ) : IEnumerable
containerName	string
blobPrefix	string
debug	bool
return	IEnumerable

ListContainers() public method

List containers/directories off the root. For storage schemes that allow real directories maybe the root will be

public ListContainers ( string root ) : List
root	string
return	List

MakeContainer() public method

Make container/directory (depending on platform).

public MakeContainer ( string containerName ) : void
containerName	string
return	void

MoveBlob() public method

Move blob

public MoveBlob ( string originContainer, string destinationContainer, string startBlobname ) : void
originContainer	string
destinationContainer	string
startBlobname	string
return	void

OverrideConfiguration() public method

public OverrideConfiguration ( string>.Dictionary configuration ) : void
configuration	string>.Dictionary
return	void

ReadBlob() public method

Read blob.

public ReadBlob ( string containerName, string blobName, string cacheFilePath = "" ) : Blob
containerName	string
blobName	string
cacheFilePath	string
return	Blob

ReadBlobSimple() public method

public ReadBlobSimple ( string container, string blobName, string filePath = "" ) : Blob
container	string
blobName	string
filePath	string
return	Blob

WriteBlob() public method

Write blob

public WriteBlob ( string containerName, string blobName, Blob blob, int parallelUploadFactor = 1, int chunkSizeInMB = 4 ) : void
containerName	string
blobName	string
blob	Blob
parallelUploadFactor	int
chunkSizeInMB	int
return	void