C# Class Microsoft.WindowsAzure.StorageClient.CloudBlockBlob

Represents a blob that is uploaded as a set of blocks.

Inheritance: CloudBlob

Show file Open project: richorama/azure-sdk-for-mono Class Usage Examples

Public Methods

Method	Description
BeginDownloadBlockList ( BlockListingFilter blockListingFilter, AsyncCallback callback, object state ) : IAsyncResult	Begins an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter.
BeginDownloadBlockList ( BlockListingFilter blockListingFilter, BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult	Begins an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter.
BeginPutBlock ( string blockId, Stream blockData, string contentMD5, AsyncCallback callback, object state ) : IAsyncResult	Begins an asynchronous operation to upload a single block.
BeginPutBlock ( string blockId, Stream blockData, string contentMD5, BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult	Begins an asynchronous operation to upload a single block.
BeginPutBlockList ( IEnumerable blockList, AsyncCallback callback, object state ) : IAsyncResult	Begins an asynchronous operation to upload a list of blocks to a new or existing blob.
BeginPutBlockList ( IEnumerable blockList, BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult	Begins an asynchronous operation to upload a list of blocks to a new or existing blob.
CloudBlockBlob ( string blobAbsoluteUri ) : System	Initializes a new instance of the CloudBlockBlob class using an absolute URI to the blob.
CloudBlockBlob ( string blobUri, CloudBlobClient client ) : System	Initializes a new instance of the CloudBlockBlob class using a relative URI to the blob.
CloudBlockBlob ( string blobUri, System.DateTime snapshotTime, CloudBlobClient client ) : System	Initializes a new instance of the CloudBlockBlob class using a relative URI to the blob.
CloudBlockBlob ( string blobAbsoluteUri, StorageCredentials credentials ) : System	Initializes a new instance of the CloudBlockBlob class using an absolute URI to the blob.
CloudBlockBlob ( string blobAbsoluteUri, StorageCredentials credentials, bool usePathStyleUris ) : System	Initializes a new instance of the CloudBlockBlob class using an absolute URI to the blob.
CloudBlockBlob ( string blobAbsoluteUri, bool usePathStyleUris ) : System	Initializes a new instance of the CloudBlockBlob class using an absolute URI to the blob.
DownloadBlockList ( ) : IEnumerable	Returns an enumerable collection of the committed blocks comprising the blob.
DownloadBlockList ( BlobRequestOptions options ) : IEnumerable	Returns an enumerable collection of the committed blocks comprising the blob.
DownloadBlockList ( BlockListingFilter blockListingFilter ) : IEnumerable	Returns an enumerable collection of the blob's blocks, using the specified block list filter.
DownloadBlockList ( BlockListingFilter blockListingFilter, BlobRequestOptions options ) : IEnumerable	Returns an enumerable collection of the blob's blocks, using the specified block list filter.
PutBlock ( string blockId, Stream blockData, string contentMD5 ) : void	Uploads a single block.
PutBlock ( string blockId, Stream blockData, string contentMD5, BlobRequestOptions options ) : void	Uploads a single block.
PutBlockList ( IEnumerable blockList ) : void	Uploads a list of blocks to a new or existing blob.
PutBlockList ( IEnumerable blockList, BlobRequestOptions options ) : void	Uploads a list of blocks to a new or existing blob.

Private Methods

Method	Description
CloudBlockBlob ( Microsoft.WindowsAzure.StorageClient.BlobAttributes attributes, CloudBlobClient serviceClient, string snapshotTime ) : System	Initializes a new instance of the CloudBlockBlob class.
CloudBlockBlob ( CloudBlob cloudBlob ) : System	Initializes a new instance of the CloudBlockBlob class based on an existing blob.
CloudBlockBlob ( string blobUri, CloudBlobClient client, CloudBlobContainer containerReference ) : System	Initializes a new instance of the CloudBlockBlob class using the specified blob Uri. Note that this is just a reference to a blob instance and no requests are issued to the service yet to update the blob properties, attribute or metaddata. FetchAttributes is the API that issues such request to the service.
CloudBlockBlob ( string blobUri, System.DateTime snapshotTime, CloudBlobClient client, CloudBlobContainer containerReference ) : System	Initializes a new instance of the CloudBlockBlob class using the specified blob Uri. If snapshotTime is not null, the blob instance represents a Snapshot. Note that this is just a reference to a blob instance and no requests are issued to the service yet to update the blob properties, attribute or metaddata. FetchAttributes is the API that issues such request to the service.
EndDownloadBlockList ( IAsyncResult asyncResult ) : IEnumerable
EndPutBlock ( IAsyncResult asyncResult ) : void
EndPutBlockList ( IAsyncResult asyncResult ) : void
GetDownloadBlockList ( BlockListingFilter typesOfBlocks, BlobRequestOptions options, Action setResult ) : System.Collections.Generic.IEnumerable	Gets the download block list.
ParseResponse ( GetBlockListResponse blockListResponse ) : IEnumerable	Parses the response.
UploadBlockList ( List blocks, BlobRequestOptions options ) : System.Collections.Generic.IEnumerable	Uploads the block list.

Method Details

BeginDownloadBlockList() public method

Begins an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter.

public BeginDownloadBlockList ( BlockListingFilter blockListingFilter, AsyncCallback callback, object state ) : IAsyncResult
blockListingFilter	BlockListingFilter	One of the enumeration values that indicates whether to return /// committed blocks, uncommitted blocks, or both.
callback	AsyncCallback	The callback delegate that will receive notification when the asynchronous operation completes.
state	object	A user-defined object that will be passed to the callback delegate.
return	IAsyncResult

BeginDownloadBlockList() public method

Begins an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter.

public BeginDownloadBlockList ( BlockListingFilter blockListingFilter, BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult
blockListingFilter	BlockListingFilter	One of the enumeration values that indicates whether to return /// committed blocks, uncommitted blocks, or both.
options	BlobRequestOptions	An object that specifies any additional options for the request.
callback	AsyncCallback	The callback delegate that will receive notification when the asynchronous operation completes.
state	object	A user-defined object that will be passed to the callback delegate.
return	IAsyncResult

BeginPutBlock() public method

Begins an asynchronous operation to upload a single block.

public BeginPutBlock ( string blockId, Stream blockData, string contentMD5, AsyncCallback callback, object state ) : IAsyncResult
blockId	string	A base64-encoded block ID that identifies the block.
blockData	Stream	A stream that provides the data for the block.
contentMD5	string	An optional hash value that will be used to set the property /// on the blob. May be null or an empty string.
callback	AsyncCallback	The callback delegate that will receive notification when the asynchronous operation completes.
state	object	A user-defined object that will be passed to the callback delegate.
return	IAsyncResult

BeginPutBlock() public method

Begins an asynchronous operation to upload a single block.

public BeginPutBlock ( string blockId, Stream blockData, string contentMD5, BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult
blockId	string	A base64-encoded block ID that identifies the block.
blockData	Stream	A stream that provides the data for the block.
contentMD5	string	An optional hash value that will be used to set the property /// on the blob. May be null or an empty string.
options	BlobRequestOptions	An object that specifies any additional options for the request.
callback	AsyncCallback	The callback delegate that will receive notification when the asynchronous operation completes.
state	object	A user-defined object that will be passed to the callback delegate.
return	IAsyncResult

BeginPutBlockList() public method

Begins an asynchronous operation to upload a list of blocks to a new or existing blob.

public BeginPutBlockList ( IEnumerable blockList, AsyncCallback callback, object state ) : IAsyncResult
blockList	IEnumerable	An enumerable collection of block IDs, as base64-encoded strings.
callback	AsyncCallback	The callback delegate that will receive notification when the asynchronous operation completes.
state	object	A user-defined object that will be passed to the callback delegate.
return	IAsyncResult

BeginPutBlockList() public method

Begins an asynchronous operation to upload a list of blocks to a new or existing blob.

public BeginPutBlockList ( IEnumerable blockList, BlobRequestOptions options, AsyncCallback callback, object state ) : IAsyncResult
blockList	IEnumerable	An enumerable collection of block IDs, as base64-encoded strings.
options	BlobRequestOptions	An object that specifies any additional options for the request.
callback	AsyncCallback	The callback delegate that will receive notification when the asynchronous operation completes.
state	object	A user-defined object that will be passed to the callback delegate.
return	IAsyncResult

CloudBlockBlob() public method

Initializes a new instance of the CloudBlockBlob class using an absolute URI to the blob.

public CloudBlockBlob ( string blobAbsoluteUri ) : System
blobAbsoluteUri	string	The absolute URI to the blob.
return	System

CloudBlockBlob() public method

Initializes a new instance of the CloudBlockBlob class using a relative URI to the blob.

public CloudBlockBlob ( string blobUri, CloudBlobClient client ) : System
blobUri	string	The relative URI to the blob, beginning with the container name.
client	CloudBlobClient	A client object that specifies the endpoint for the Blob service.
return	System

CloudBlockBlob() public method

Initializes a new instance of the CloudBlockBlob class using a relative URI to the blob.

public CloudBlockBlob ( string blobUri, System.DateTime snapshotTime, CloudBlobClient client ) : System
blobUri	string	The relative URI to the blob, beginning with the container name.
snapshotTime	System.DateTime	The snapshot timestamp, if the blob is a snapshot.
client	CloudBlobClient	A client object that specifies the endpoint for the Blob service.
return	System

CloudBlockBlob() public method

Initializes a new instance of the CloudBlockBlob class using an absolute URI to the blob.

public CloudBlockBlob ( string blobAbsoluteUri, StorageCredentials credentials ) : System
blobAbsoluteUri	string	The absolute URI to the blob.
credentials	StorageCredentials	The account credentials.
return	System

CloudBlockBlob() public method

Initializes a new instance of the CloudBlockBlob class using an absolute URI to the blob.

public CloudBlockBlob ( string blobAbsoluteUri, StorageCredentials credentials, bool usePathStyleUris ) : System
blobAbsoluteUri	string	The absolute URI to the blob.
credentials	StorageCredentials	The account credentials.
usePathStyleUris	bool	True to use path-style URIs; otherwise, false.
return	System

CloudBlockBlob() public method

Initializes a new instance of the CloudBlockBlob class using an absolute URI to the blob.

public CloudBlockBlob ( string blobAbsoluteUri, bool usePathStyleUris ) : System
blobAbsoluteUri	string	The absolute URI to the blob.
usePathStyleUris	bool	True to use path-style URIs; otherwise, false.
return	System

DownloadBlockList() public method

Returns an enumerable collection of the committed blocks comprising the blob.

public DownloadBlockList ( ) : IEnumerable
return	IEnumerable

DownloadBlockList() public method

Returns an enumerable collection of the committed blocks comprising the blob.

public DownloadBlockList ( BlobRequestOptions options ) : IEnumerable
options	BlobRequestOptions	An object that specifies any additional options for the request.
return	IEnumerable

DownloadBlockList() public method

Returns an enumerable collection of the blob's blocks, using the specified block list filter.

public DownloadBlockList ( BlockListingFilter blockListingFilter ) : IEnumerable
blockListingFilter	BlockListingFilter	One of the enumeration values that indicates whether to return /// committed blocks, uncommitted blocks, or both.
return	IEnumerable

DownloadBlockList() public method

Returns an enumerable collection of the blob's blocks, using the specified block list filter.

public DownloadBlockList ( BlockListingFilter blockListingFilter, BlobRequestOptions options ) : IEnumerable
blockListingFilter	BlockListingFilter	One of the enumeration values that indicates whether to return /// committed blocks, uncommitted blocks, or both.
options	BlobRequestOptions	An object that specifies any additional options for the request.
return	IEnumerable

PutBlock() public method

Uploads a single block.

public PutBlock ( string blockId, Stream blockData, string contentMD5 ) : void
blockId	string	A base64-encoded block ID that identifies the block.
blockData	Stream	A stream that provides the data for the block.
contentMD5	string	An optional hash value that will be used to set the property /// on the blob. May be null or an empty string.
return	void

PutBlock() public method

Uploads a single block.

public PutBlock ( string blockId, Stream blockData, string contentMD5, BlobRequestOptions options ) : void
blockId	string	A base64-encoded block ID that identifies the block.
blockData	Stream	A stream that provides the data for the block.
contentMD5	string	An optional hash value that will be used to set the property /// on the blob. May be null or an empty string.
options	BlobRequestOptions	An object that specifies any additional options for the request.
return	void

PutBlockList() public method

Uploads a list of blocks to a new or existing blob.

public PutBlockList ( IEnumerable blockList ) : void
blockList	IEnumerable	An enumerable collection of block IDs, as base64-encoded strings.
return	void

PutBlockList() public method

Uploads a list of blocks to a new or existing blob.

public PutBlockList ( IEnumerable blockList, BlobRequestOptions options ) : void
blockList	IEnumerable	An enumerable collection of block IDs, as base64-encoded strings.
options	BlobRequestOptions	An object that specifies any additional options for the request.
return	void