AZSCloudPageBlob Class Reference

Inherits from AZSCloudBlob : NSObject
Declared in AZSCloudPageBlob.h
AZSCloudPageBlob.m

– initWithUrl:error:

Initializes a newly allocated AZSCloudPageBlob object

- (instancetype)initWithUrl:(NSURL *)blobAbsoluteUrl error:(NSError **)error

Parameters

blobAbsoluteUrl

The absolute URL to the blob.

Return Value

The newly allocated instance.

Discussion

Initializes a newly allocated AZSCloudPageBlob object

Declared In

AZSCloudPageBlob.h

– initWithUrl:credentials:snapshotTime:error:

Initializes a newly allocated AZSCloudPageBlob object

- (instancetype)initWithUrl:(NSURL *)blobAbsoluteUrl credentials:(AZSNullable AZSStorageCredentials *)credentials snapshotTime:(AZSNullable NSString *)snapshotTime error:(NSError **)error

Parameters

blobAbsoluteUrl

The absolute URL to the blob.

credentials

The AZSStorageCredentials used to authenticate to the blob

snapshotTime

The timestamp of the intended snapshot. If nil, this AZSCloudPageBlob object refers to the actual blob, not a snapshot.

Return Value

The newly allocated instance.

Discussion

Initializes a newly allocated AZSCloudPageBlob object

Declared In

AZSCloudPageBlob.h

– initWithStorageUri:error:

Initializes a newly allocated AZSCloudPageBlob object

- (instancetype)initWithStorageUri:(AZSStorageUri *)blobAbsoluteUri error:(NSError **)error

Parameters

blobAbsoluteUri

The absolute URL to the blob.

Return Value

The newly allocated instance.

Discussion

Initializes a newly allocated AZSCloudPageBlob object

Declared In

AZSCloudPageBlob.h

– initWithStorageUri:credentials:snapshotTime:error:

Initializes a newly allocated AZSCloudPageBlob object

- (instancetype)initWithStorageUri:(AZSStorageUri *)blobAbsoluteUri credentials:(AZSNullable AZSStorageCredentials *)credentials snapshotTime:(AZSNullable NSString *)snapshotTime error:(NSError **)error

Parameters

blobAbsoluteUri

The absolute URL to the blob.

credentials

The AZSStorageCredentials used to authenticate to the blob

snapshotTime

The timestamp of the intended snapshot. If nil, this AZSCloudPageBlob object refers to the actual blob, not a snapshot.

Return Value

The newly allocated instance.

Discussion

Initializes a newly allocated AZSCloudPageBlob object

Declared In

AZSCloudPageBlob.h

– initWithContainer:name:

Initializes a newly allocated AZSCloudPageBlob object

- (instancetype)initWithContainer:(AZSCloudBlobContainer *)blobContainer name:(NSString *)blobName

Parameters

blobContainer

The AZSCloudBlobContainer in which the blob exists or should be created.

blobName

The name of the blob.

Return Value

The newly allocated instance.

Discussion

Initializes a newly allocated AZSCloudPageBlob object

Declared In

AZSCloudPageBlob.h

– initWithContainer:name:snapshotTime:

Initializes a newly allocated AZSCloudPageBlob object

- (instancetype)initWithContainer:(AZSCloudBlobContainer *)blobContainer name:(NSString *)blobName snapshotTime:(AZSNullable NSString *)snapshotTime

Parameters

blobContainer

The AZSCloudBlobContainer in which the blob exists or should be created.

blobName

The name of the blob.

snapshotTime

The timestamp of the intended snapshot. If nil, this AZSCloudPageBlob object refers to the actual blob, not a snapshot.

Return Value

The newly allocated instance.

Discussion

Initializes a newly allocated AZSCloudPageBlob object

Declared In

AZSCloudPageBlob.h

– clearPagesWithAZSULLRange:completionHandler:

Clears a set of bytes from the page blob.

- (void)clearPagesWithAZSULLRange:(AZSULLRange)range completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

range

The range of bytes to clear (set to all 0) from the page blob. Note that this must be 512-byte aligned. Can be up to the full size of the blob.

completionHandler

The block of code to execute when the clear call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.|

Discussion

Clears a set of bytes from the page blob.

Declared In

AZSCloudPageBlob.h

– clearPagesWithAZSULLRange:accessCondition:requestOptions:operationContext:completionHandler:

Clears a set of bytes from the page blob.

- (void)clearPagesWithAZSULLRange:(AZSULLRange)range accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

range

The range of bytes to clear (set to all 0) from the page blob. Note that this must be 512-byte aligned. Can be up to the full size of the blob.

accessCondition

The access condition for the request.

requestOptions

The options to use for the request.

operationContext

The operation context to use for the call.

completionHandler

The block of code to execute when the clear call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.|

Discussion

Clears a set of bytes from the page blob.

Declared In

AZSCloudPageBlob.h

– clearPagesWithRange:completionHandler:

Clears a set of bytes from the page blob.

- (void)clearPagesWithRange:(NSRange)range completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

range

The range of bytes to clear (set to all 0) from the page blob. Note that this must be 512-byte aligned. Can be up to the full size of the blob.

completionHandler

The block of code to execute when the clear call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.|

Discussion

Clears a set of bytes from the page blob.

Declared In

AZSCloudPageBlob.h

– clearPagesWithRange:accessCondition:requestOptions:operationContext:completionHandler:

Clears a set of bytes from the page blob.

- (void)clearPagesWithRange:(NSRange)range accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

range

The range of bytes to clear (set to all 0) from the page blob. Note that this must be 512-byte aligned. Can be up to the full size of the blob.

accessCondition

The access condition for the request.

requestOptions

The options to use for the request.

operationContext

The operation context to use for the call.

completionHandler

The block of code to execute when the clear call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.|

Discussion

Clears a set of bytes from the page blob.

Declared In

AZSCloudPageBlob.h

– downloadPageRangesWithCompletionHandler:

Downloads the non-clear page ranges from the blob.

- (void)downloadPageRangesWithCompletionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSArray *))completionHandler

Parameters

completionHandler

The block of code to execute when the query page ranges call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.| |NSArray * | The page ranges queried. Each item in this array is of type NSValue*, which contains an AZSULLRange.|

Discussion

Downloads the non-clear page ranges from the blob.

This method will query the page blob on the service, and download all page ranges that are non-zero (non-clear). If this method times out, consider breaking up the query into smaller ranges.

Declared In

AZSCloudPageBlob.h

– downloadPageRangesWithAZSULLRange:completionHandler:

Downloads the non-clear page ranges from the blob.

This method will query the page blob on the service, and download all page ranges in the input range that are non-zero (non-clear). If this method times out, consider breaking up the query into smaller ranges.

- (void)downloadPageRangesWithAZSULLRange:(AZSULLRange)range completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSArray *))completionHandler

Parameters

range

The range of the blob to query.

completionHandler

The block of code to execute when the query page ranges call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.| |NSArray * | The page ranges queried. Each item in this array is of type NSValue*, which contains an AZSULLRange.|

Discussion

Downloads the non-clear page ranges from the blob.

This method will query the page blob on the service, and download all page ranges in the input range that are non-zero (non-clear). If this method times out, consider breaking up the query into smaller ranges.

Declared In

AZSCloudPageBlob.h

– downloadPageRangesWithAZSULLRange:accessCondition:requestOptions:operationContext:completionHandler:

Downloads the non-clear page ranges from the blob.

- (void)downloadPageRangesWithAZSULLRange:(AZSULLRange)range accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSArray *))completionHandler

Parameters

range

The range of the blob to query.

accessCondition

The access condition for the request.

requestOptions

The options to use for the request.

operationContext

The operation context to use for the call.

completionHandler

The block of code to execute when the query page ranges call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.| |NSArray * | The page ranges queried. Each item in this array is of type NSValue*, which contains an AZSULLRange.|

Discussion

Downloads the non-clear page ranges from the blob.

This method will query the page blob on the service, and download all page ranges in the input range that are non-zero (non-clear). If this method times out, consider breaking up the query into smaller ranges.

Declared In

AZSCloudPageBlob.h

– downloadPageRangesWithRange:completionHandler:

Downloads the non-clear page ranges from the blob.

- (void)downloadPageRangesWithRange:(NSRange)range completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSArray *))completionHandler

Parameters

range

The range of the blob to query.

completionHandler

The block of code to execute when the query page ranges call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.| |NSArray * | The page ranges queried. Each item in this array is of type NSValue*, which contains an AZSULLRange.|

Discussion

Downloads the non-clear page ranges from the blob.

This method will query the page blob on the service, and download all page ranges in the input range that are non-zero (non-clear). If this method times out, consider breaking up the query into smaller ranges.

Declared In

AZSCloudPageBlob.h

– downloadPageRangesWithRange:accessCondition:requestOptions:operationContext:completionHandler:

Downloads the non-clear page ranges from the blob.

- (void)downloadPageRangesWithRange:(NSRange)range accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , NSArray *))completionHandler

Parameters

range

The range of the blob to query.

accessCondition

The access condition for the request.

requestOptions

The options to use for the request.

operationContext

The operation context to use for the call.

completionHandler

The block of code to execute when the query page ranges call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.| |NSArray * | The page ranges queried. Each item in this array is of type NSValue*, which contains an AZSULLRange.|

Discussion

Downloads the non-clear page ranges from the blob.

This method will query the page blob on the service, and download all page ranges in the input range that are non-zero (non-clear). If this method times out, consider breaking up the query into smaller ranges.

Declared In

AZSCloudPageBlob.h

– createWithSize:completionHandler:

Creates the page blob on the service.

- (void)createWithSize:(NSNumber *)totalBlobSize completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

totalBlobSize

The total size of the blob. This must be known at creation time for page blobs.

completionHandler

The block of code to execute when the create call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.|

Discussion

Creates the page blob on the service.

Unlike block blobs, page and append blobs must be explicitly created on the service before data can be written. This method does the creation.

Declared In

AZSCloudPageBlob.h

– createWithSize:sequenceNumber:completionHandler:

Creates the page blob on the service.

- (void)createWithSize:(NSNumber *)totalBlobSize sequenceNumber:(AZSNullable NSNumber *)sequenceNumber completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

totalBlobSize

The total size of the blob. This must be known at creation time for page blobs.

sequenceNumber

The intiial sequence number for the blob. If nil, a default value will be used.

completionHandler

The block of code to execute when the create call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.|

Discussion

Creates the page blob on the service.

Unlike block blobs, page and append blobs must be explicitly created on the service before data can be written. This method does the creation.

Declared In

AZSCloudPageBlob.h

– createWithSize:sequenceNumber:accessCondition:requestOptions:operationContext:completionHandler:

Creates the page blob on the service.

- (void)createWithSize:(NSNumber *)totalBlobSize sequenceNumber:(AZSNullable NSNumber *)sequenceNumber accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

totalBlobSize

The total size of the blob. This must be known at creation time for page blobs.

sequenceNumber

The intiial sequence number for the blob. If nil, a default value will be used.

accessCondition

The access condition for the request.

requestOptions

The options to use for the request.

operationContext

The operation context to use for the call.

completionHandler

The block of code to execute when the create call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.|

Discussion

Creates the page blob on the service.

Unlike block blobs, page and append blobs must be explicitly created on the service before data can be written. This method does the creation.

Declared In

AZSCloudPageBlob.h

– createIfNotExistsWithSize:completionHandler:

Creates the page blob on the service if it does not already exist.

- (void)createIfNotExistsWithSize:(NSNumber *)totalBlobSize completionHandler:(void ( ^ ) ( NSError *__AZSNullable , BOOL ))completionHandler

Parameters

totalBlobSize

The total size of the blob. This must be known at creation time for page blobs.

completionHandler

The block of code to execute when the create call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.| |BOOL | YES if the blob was successfully created with this call. NO if the blob already existed.|

Discussion

Creates the page blob on the service if it does not already exist.

Unlike block blobs, page and append blobs must be explicitly created on the service before data can be written. This method does the creation.

Declared In

AZSCloudPageBlob.h

– createIfNotExistsWithSize:sequenceNumber:completionHandler:

Creates the page blob on the service if it does not already exist.

- (void)createIfNotExistsWithSize:(NSNumber *)totalBlobSize sequenceNumber:(AZSNullable NSNumber *)sequenceNumber completionHandler:(void ( ^ ) ( NSError *__AZSNullable , BOOL ))completionHandler

Parameters

totalBlobSize

The total size of the blob. This must be known at creation time for page blobs.

sequenceNumber

The intiial sequence number for the blob. If nil, a default value will be used.

completionHandler

The block of code to execute when the create call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.| |BOOL | YES if the blob was successfully created with this call. NO if the blob already existed.|

Discussion

Creates the page blob on the service if it does not already exist.

Unlike block blobs, page and append blobs must be explicitly created on the service before data can be written. This method does the creation.

Declared In

AZSCloudPageBlob.h

– createIfNotExistsWithSize:sequenceNumber:accessCondition:requestOptions:operationContext:completionHandler:

Creates the page blob on the service if it does not already exist.

- (void)createIfNotExistsWithSize:(NSNumber *)totalBlobSize sequenceNumber:(AZSNullable NSNumber *)sequenceNumber accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , BOOL ))completionHandler

Parameters

totalBlobSize

The total size of the blob. This must be known at creation time for page blobs.

sequenceNumber

The intiial sequence number for the blob. If nil, a default value will be used.

accessCondition

The access condition for the request.

requestOptions

The options to use for the request.

operationContext

The operation context to use for the call.

completionHandler

The block of code to execute when the create call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.| |BOOL | YES if the blob was successfully created with this call. NO if the blob already existed.|

Discussion

Creates the page blob on the service if it does not already exist.

Unlike block blobs, page and append blobs must be explicitly created on the service before data can be written. This method does the creation.

Declared In

AZSCloudPageBlob.h

– resizeWithSize:completionHandler:

Sets the total blob size.

- (void)resizeWithSize:(NSNumber *)totalBlobSize completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

totalBlobSize

The new blob size.

completionHandler

The block of code to execute when the resize call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.|

Discussion

Sets the total blob size.

If the new size is less than the old size, the blob will be truncated.

Declared In

AZSCloudPageBlob.h

– resizeWithSize:accessCondition:requestOptions:operationContext:completionHandler:

Sets the total blob size.

- (void)resizeWithSize:(NSNumber *)totalBlobSize accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

totalBlobSize

The new blob size.

accessCondition

The access condition for the request.

requestOptions

The options to use for the request.

operationContext

The operation context to use for the call.

completionHandler

The block of code to execute when the resize call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.|

Discussion

Sets the total blob size.

If the new size is less than the old size, the blob will be truncated.

Declared In

AZSCloudPageBlob.h

– incrementSequenceNumberWithCompletionHandler:

Increments the sequence number of the page blob on the service.

- (void)incrementSequenceNumberWithCompletionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

completionHandler

The block of code to execute when the increment call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.|

Discussion

Increments the sequence number of the page blob on the service.

Declared In

AZSCloudPageBlob.h

– incrementSequenceNumberWithAccessCondition:requestOptions:operationContext:completionHandler:

Increments the sequence number of the page blob on the service.

- (void)incrementSequenceNumberWithAccessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

accessCondition

The access condition for the request.

requestOptions

The options to use for the request.

operationContext

The operation context to use for the call.

completionHandler

The block of code to execute when the increment call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.|

Discussion

Increments the sequence number of the page blob on the service.

Declared In

AZSCloudPageBlob.h

– setSequenceNumberWithNumber:useMaximum:completionHandler:

Sets the sequence number of the page blob on the service.

- (void)setSequenceNumberWithNumber:(NSNumber *)newSequenceNumber useMaximum:(BOOL)useMaximum completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

newSequenceNumber

The sequence number to set the blob to.

useMaximum

If YES, this method will set the sequence number to the larger of its existing value, and the input value. If NO, the blob will get the new value, regardless of existing value.

completionHandler

The block of code to execute when the set sequence number call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.|

Discussion

Sets the sequence number of the page blob on the service.

Declared In

AZSCloudPageBlob.h

– setSequenceNumberWithNumber:useMaximum:accessCondition:requestOptions:operationContext:completionHandler:

Sets the sequence number of the page blob on the service.

- (void)setSequenceNumberWithNumber:(NSNumber *)newSequenceNumber useMaximum:(BOOL)useMaximum accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

newSequenceNumber

The sequence number to set the blob to.

useMaximum

If YES, this method will set the sequence number to the larger of its existing value, and the input value. If NO, the blob will get the new value, regardless of existing value.

operationContext

The operation context to use for the call.

completionHandler

The block of code to execute when the set sequence number call completes. | Parameter name | Description | |—————-|————-| |NSError * | Nil if the operation succeeded without error, error with details about the failure otherwise.|

Discussion

Sets the sequence number of the page blob on the service.

Declared In

AZSCloudPageBlob.h

– createOutputStream

Creates an output stream that is capable of writing to an existing page blob.

- (AZSBlobOutputStream *)createOutputStream

Return Value

The created AZSBlobOutputStream, capable of writing to this blob.

Discussion

Creates an output stream that is capable of writing to an existing page blob.

This method returns an instance of AZSBlobOutputStream. The caller can then assign a delegate and schedule the stream in a runloop (similar to any other NSOutputStream.) See AZSBlobOutputStream documentation for details.

Declared In

AZSCloudPageBlob.h

– createOutputStreamWithAccessCondition:requestOptions:operationContext:

Creates an output stream that is capable of writing to an existing page blob.

- (AZSBlobOutputStream *)createOutputStreamWithAccessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext

Parameters

accessCondition

The access condition for the request.

requestOptions

The options to use for the request.

operationContext

The operation context to use for the call.

Return Value

The created AZSBlobOutputStream, capable of writing to this blob.

Discussion

Creates an output stream that is capable of writing to an existing page blob.

This method returns an instance of AZSBlobOutputStream. The caller can then assign a delegate and schedule the stream in a runloop (similar to any other NSOutputStream.) See AZSBlobOutputStream documentation for details.

Declared In

AZSCloudPageBlob.h

– createOutputStreamWithSize:

Creates an output stream that is capable of writing to a new page blob.

- (AZSBlobOutputStream *)createOutputStreamWithSize:(NSNumber *)totalBlobSize

Parameters

totalBlobSize

The total blob size

Return Value

The created AZSBlobOutputStream, capable of writing to this blob.

Discussion

Creates an output stream that is capable of writing to a new page blob.

This method returns an instance of AZSBlobOutputStream. The caller can then assign a delegate and schedule the stream in a runloop (similar to any other NSOutputStream.) See AZSBlobOutputStream documentation for details.

Declared In

AZSCloudPageBlob.h

– createOutputStreamWithSize:sequenceNumber:

Creates an output stream that is capable of writing to a new page blob.

- (AZSBlobOutputStream *)createOutputStreamWithSize:(NSNumber *)totalBlobSize sequenceNumber:(AZSNullable NSNumber *)sequenceNumber

Parameters

totalBlobSize

The total blob size

sequenceNumber

The initial page blob sequence number for the request.

Return Value

The created AZSBlobOutputStream, capable of writing to this blob.

Discussion

Creates an output stream that is capable of writing to a new page blob.

This method returns an instance of AZSBlobOutputStream. The caller can then assign a delegate and schedule the stream in a runloop (similar to any other NSOutputStream.) See AZSBlobOutputStream documentation for details.

Declared In

AZSCloudPageBlob.h

– createOutputStreamWithSize:sequenceNumber:accessCondition:requestOptions:operationContext:

Creates an output stream that is capable of writing to a new page blob.

- (AZSBlobOutputStream *)createOutputStreamWithSize:(NSNumber *)totalBlobSize sequenceNumber:(AZSNullable NSNumber *)sequenceNumber accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext

Parameters

totalBlobSize

The total blob size

accessCondition

The access condition for the request.

requestOptions

The options to use for the request.

operationContext

The operation context to use for the call.

Return Value

The created AZSBlobOutputStream, capable of writing to this blob.

Discussion

Creates an output stream that is capable of writing to a new page blob.

This method returns an instance of AZSBlobOutputStream. The caller can then assign a delegate and schedule the stream in a runloop (similar to any other NSOutputStream.) See AZSBlobOutputStream documentation for details.

Declared In

AZSCloudPageBlob.h

– uploadFromStream:completionHandler:

Uploades to an existing page blob from given source stream.

- (void)uploadFromStream:(NSInputStream *)sourceStream completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

sourceStream

The stream containing the data that the blob should contain.

completionHandler

The block of code to execute when the upload call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Uploades to an existing page blob from given source stream.

This operation will schedule the input sourceStream on a runloop (created in a new thread), and read in all data as long as it is able. This will chunk the data into blocks, and upload each of those blocks to the service. Finally, when the stream is finished, it will upload a block list consisting of all read data.

No more than one block’s worth of data will be uploaded at a time. Block size is configurable in the AZSBlobRequestOptions (see – uploadFromStream:accessCondition:requestOptions:operationContext:completionHandler:). Maximum number of outstanding downloads is also configurable in the AZSBlobRequestOptions.

Declared In

AZSCloudPageBlob.h

– uploadFromStream:accessCondition:requestOptions:operationContext:completionHandler:

Uploades to an existing page blob from given source stream.

- (void)uploadFromStream:(NSInputStream *)sourceStream accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

sourceStream

The stream containing the data that the blob should contain.

accessCondition

The access condition for the request.

requestOptions

The options to use for the request.

operationContext

The operation context to use for the call.

completionHandler

The block of code to execute when the upload call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Uploades to an existing page blob from given source stream.

This operation will schedule the input sourceStream on a runloop (created in a new thread), and read in all data as long as it is able. This will chunk the data into blocks, and upload each of those blocks to the service. Finally, when the stream is finished, it will upload a block list consisting of all read data.

No more than one block’s worth of data will be uploaded at a time. Block size is configurable in the AZSBlobRequestOptions. Maximum number of outstanding downloads is also configurable in the AZSBlobRequestOptions.

Declared In

AZSCloudPageBlob.h

– uploadFromStream:size:completionHandler:

Uploades to a new page blob from given source stream.

- (void)uploadFromStream:(NSInputStream *)sourceStream size:(NSNumber *)totalBlobSize completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

sourceStream

The stream containing the data that the blob should contain.

totalBlobSize

The total blob size

completionHandler

The block of code to execute when the upload call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Uploades to a new page blob from given source stream.

This operation will schedule the input sourceStream on a runloop (created in a new thread), and read in all data as long as it is able. This will chunk the data into blocks, and upload each of those blocks to the service. Finally, when the stream is finished, it will upload a block list consisting of all read data.

No more than one block’s worth of data will be uploaded at a time. Block size is configurable in the AZSBlobRequestOptions. Maximum number of outstanding downloads is also configurable in the AZSBlobRequestOptions.

Declared In

AZSCloudPageBlob.h

– uploadFromStream:size:initialSequenceNumber:completionHandler:

Uploades to a new page blob from given source stream.

- (void)uploadFromStream:(NSInputStream *)sourceStream size:(NSNumber *)totalBlobSize initialSequenceNumber:(AZSNullable NSNumber *)initialSequenceNumber completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

sourceStream

The stream containing the data that the blob should contain.

totalBlobSize

The total blob size

initialSequenceNumber

The initial page blob sequence number

completionHandler

The block of code to execute when the upload call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Uploades to a new page blob from given source stream.

This operation will schedule the input sourceStream on a runloop (created in a new thread), and read in all data as long as it is able. This will chunk the data into blocks, and upload each of those blocks to the service. Finally, when the stream is finished, it will upload a block list consisting of all read data.

No more than one block’s worth of data will be uploaded at a time. Block size is configurable in the AZSBlobRequestOptions. Maximum number of outstanding downloads is also configurable in the AZSBlobRequestOptions.

Declared In

AZSCloudPageBlob.h

– uploadFromStream:size:initialSequenceNumber:accessCondition:requestOptions:operationContext:completionHandler:

Uploades to a new page blob from given source stream.

- (void)uploadFromStream:(NSInputStream *)sourceStream size:(NSNumber *)totalBlobSize initialSequenceNumber:(AZSNullable NSNumber *)initialSequenceNumber accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

sourceStream

The stream containing the data that the blob should contain.

accessCondition

The access condition for the request.

requestOptions

The options to use for the request.

operationContext

The operation context to use for the call.

completionHandler

The block of code to execute when the upload call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.

Discussion

Uploades to a new page blob from given source stream.

This operation will schedule the input sourceStream on a runloop (created in a new thread), and read in all data as long as it is able. This will chunk the data into blocks, and upload each of those blocks to the service. Finally, when the stream is finished, it will upload a block list consisting of all read data.

No more than one block’s worth of data will be uploaded at a time. Block size is configurable in the AZSBlobRequestOptions. Maximum number of outstanding downloads is also configurable in the AZSBlobRequestOptions.

Declared In

AZSCloudPageBlob.h