AZSCloudBlobDirectory Class Reference

Inherits from NSObject
Declared in AZSCloudBlobDirectory.h
AZSCloudBlobDirectory.m

  blobContainer

The container in which this blob directory exists.

@property (strong, readonly) AZSCloudBlobContainer *blobContainer

Discussion

The container in which this blob directory exists.

Declared In

AZSCloudBlobDirectory.h

  storageUri

The full StorageURI to this blob directory.

@property (strong, readonly) AZSStorageUri *storageUri

Discussion

The full StorageURI to this blob directory.

Declared In

AZSCloudBlobDirectory.h

  client

The blob client representing the blob service for this blob directory.

@property (strong, readonly) AZSCloudBlobClient *client

Discussion

The blob client representing the blob service for this blob directory.

Declared In

AZSCloudBlobDirectory.h

  name

The name of this directory.

@property (strong, readonly) NSString *name

Discussion

The name of this directory.

Declared In

AZSCloudBlobDirectory.h

– initWithDirectoryName:container:

Initializes a newly allocated AZSCloudBlockDirectory object

- (instancetype)initWithDirectoryName:(NSString *)directoryName container:(AZSCloudBlobContainer *)container

Parameters

directoryName

The name of the directory. This should be the path to the directory, relative to the container name. For example:

If the full URI to the directory is https://myaccount.blob.core.windows.net/mycontainer/dir1/dir2/dir3 then this parameter should be: dir1/dir2/dir3.
container

The AZSCloudBlobContainer in which the container exists.

Return Value

The newly allocated instance.

Discussion

Initializes a newly allocated AZSCloudBlockDirectory object

Declared In

AZSCloudBlobDirectory.h

– blockBlobReferenceFromName:

Initialize a local AZSCloudBlockBlob object

- (AZSCloudBlockBlob *)blockBlobReferenceFromName:(NSString *)blobName

Parameters

blobName

The name of the block blob (part of the URL)

Return Value

The block blob object.

Discussion

Initialize a local AZSCloudBlockBlob object

This creates an AZSCloudBlockBlob object with the input name.

TODO: Consider renaming this ‘blockBlobFromName’. This is better Objective-C style, but may confuse users into thinking that this method creates a blob on the service, which is does not.

Warning: This method does not make a service call. If properties, metadata, etc have been set on the service for this blob, this will not be reflected in the local container object.

Declared In

AZSCloudBlobDirectory.h

– blockBlobReferenceFromName:snapshotTime:

Initialize a local AZSCloudBlockBlob object

- (AZSCloudBlockBlob *)blockBlobReferenceFromName:(NSString *)blobName snapshotTime:(AZSNullable NSString *)snapshotTime

Parameters

blobName

The name of the block blob (part of the URL)
snapshotTime

The snapshot time for the blob. Nil means the root blob (not a snapshot).

Return Value

The block blob object.

Discussion

Initialize a local AZSCloudBlockBlob object

This creates an AZSCloudBlockBlob object with the input name.

TODO: Consider renaming this ‘blockBlobFromName’. This is better Objective-C style, but may confuse users into thinking that this method creates a blob on the service, which is does not.

Warning: This method does not make a service call. If properties, metadata, etc have been set on the service for this blob, this will not be reflected in the local container object.

Declared In

AZSCloudBlobDirectory.h

– pageBlobReferenceFromName:

Initialize a local AZSCloudPageBlob object

- (AZSCloudPageBlob *)pageBlobReferenceFromName:(NSString *)blobName

Parameters

blobName

The name of the page blob (part of the URL)

Return Value

The new page blob object.

Discussion

Initialize a local AZSCloudPageBlob object

This creates an AZSCloudPageBlob object with the input name.

Warning: This method does not make a service call. If properties, metadata, etc have been set on the service for this blob, this will not be reflected in the local container object.

Declared In

AZSCloudBlobDirectory.h

– pageBlobReferenceFromName:snapshotTime:

Initialize a local AZSCloudPageBlob object

- (AZSCloudPageBlob *)pageBlobReferenceFromName:(NSString *)blobName snapshotTime:(AZSNullable NSString *)snapshotTime

Parameters

blobName

The name of the page blob (part of the URL)
snapshotTime

The snapshot time for the blob. Nil means the root blob (not a snapshot).

Return Value

The new page blob object.

Discussion

Initialize a local AZSCloudPageBlob object

This creates an AZSCloudPageBlob object with the input name.

Warning: This method does not make a service call. If properties, metadata, etc have been set on the service for this blob, this will not be reflected in the local container object.

Declared In

AZSCloudBlobDirectory.h

– appendBlobReferenceFromName:

Initialize a local AZSCloudAppendBlob object

- (AZSCloudAppendBlob *)appendBlobReferenceFromName:(NSString *)blobName

Parameters

blobName

The name of the append blob (part of the URL)

Return Value

The new append blob object.

Discussion

Initialize a local AZSCloudAppendBlob object

This creates an AZSCloudAppendBlob object with the input name.

Warning: This method does not make a service call. If properties, metadata, etc have been set on the service for this blob, this will not be reflected in the local container object.

Declared In

AZSCloudBlobDirectory.h

– appendBlobReferenceFromName:snapshotTime:

Initialize a local AZSCloudAppendBlob object

- (AZSCloudAppendBlob *)appendBlobReferenceFromName:(NSString *)blobName snapshotTime:(AZSNullable NSString *)snapshotTime

Parameters

blobName

The name of the block blob (part of the URL)
snapshotTime

The snapshot time for the blob. Nil means the root blob (not a snapshot).

Return Value

The new block blob object.

Discussion

Initialize a local AZSCloudAppendBlob object

This creates an AZSCloudAppendBlob object with the input name.

Warning: This method does not make a service call. If properties, metadata, etc have been set on the service for this blob, this will not be reflected in the local container object.

Declared In

AZSCloudBlobDirectory.h

– parentReference

Initialize a AZSCloudBlobDiretory object that represents the ‘parent’ directory of the current object.

- (AZSCloudBlobDirectory *)parentReference

Return Value

The newly allocated parent directory object.

Discussion

Initialize a AZSCloudBlobDiretory object that represents the ‘parent’ directory of the current object.

For example, if the current directory has the name:

“sample/a/b/c”

this method will return a new CloudBlobDirectory object with the name:

“sample/a/b”.

The delimiter used is the one set in self.client.

Declared In

AZSCloudBlobDirectory.h

– subdirectoryReferenceFromName:

Initialize a AZSCloudBlobDiretory object that represents the ‘child’ directory of the current object.

- (AZSCloudBlobDirectory *)subdirectoryReferenceFromName:(NSString *)subdirectoryName

Parameters

subdirectoryName

The name of the subdirectory.

Return Value

The newly allocated subdirectory object.

Discussion

Initialize a AZSCloudBlobDiretory object that represents the ‘child’ directory of the current object.

For example, if the current directory has the name:

“sample/a/b/c”

and this method is called with input “next”, it will return a new CloudBlobDirectory object with the name:

“sample/a/b/c/next”.

The delimiter used is the one set in self.client.

Declared In

AZSCloudBlobDirectory.h

– listBlobsSegmentedWithContinuationToken:useFlatBlobListing:blobListingDetails:maxResults:completionHandler:

Performs one segmented blob listing operation.

- (void)listBlobsSegmentedWithContinuationToken:(AZSNullable AZSContinuationToken *)token useFlatBlobListing:(BOOL)useFlatBlobListing blobListingDetails:(AZSBlobListingDetails)blobListingDetails maxResults:(NSInteger)maxResults completionHandler:(void ( ^ ) ( NSError *__AZSNullable , AZSBlobResultSegment *__AZSNullable ))completionHandler

Parameters

token

The token representing where the listing operation should start.
useFlatBlobListing

YES if the blob list should be flat (list all blobs as if their names were only strings, no directories). NO if it should list with directories.
blobListingDetails

Details about how to list blobs. See AZSBlobListingDetails for the possible options.
maxResults

The maximum number of results to return for this operation. Use -1 to not set a limit.
completionHandler

The block of code to execute with the results of the listing operation.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
AZSBlobResultSegment * The blob result segment containing the result of the listing operation.

Discussion

Performs one segmented blob listing operation.

This method lists the blobs in the given directory. It will perform exactly one REST call, which will list blobs beginning with the directory represented in the AZSContinuationToken. If no token is provided, it will list blobs from the beginning. Only blobs that begin with the input prefix will be listed.

Any number of blobs can be listed, from zero up to a set maximum. Even if this method returns zero results, if the AZSContinuationToken in the result is not nil, there may be more blobs on the service that have not been listed.

Declared In

AZSCloudBlobDirectory.h

– listBlobsSegmentedWithContinuationToken:useFlatBlobListing:blobListingDetails:maxResults:accessCondition:requestOptions:operationContext:completionHandler:

Performs one segmented blob listing operation.

- (void)listBlobsSegmentedWithContinuationToken:(AZSNullable AZSContinuationToken *)token useFlatBlobListing:(BOOL)useFlatBlobListing blobListingDetails:(AZSBlobListingDetails)blobListingDetails maxResults:(NSInteger)maxResults accessCondition:(AZSNullable AZSAccessCondition *)accessCondition requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , AZSBlobResultSegment *__AZSNullable ))completionHandler

Parameters

token

The token representing where the listing operation should start.
useFlatBlobListing

YES if the blob list should be flat (list all blobs as if their names were only strings, no directories). NO if it should list with directories.
blobListingDetails

Details about how to list blobs. See AZSBlobListingDetails for the possible options.
maxResults

The maximum number of results to return for this operation. Use -1 to not set a limit.
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 with the results of the listing operation.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
AZSBlobResultSegment * The blob result segment containing the result of the listing operation.

Discussion

Performs one segmented blob listing operation.

This method lists the blobs in the given directory. It will perform exactly one REST call, which will list blobs beginning with the directory represented in the AZSContinuationToken. If no token is provided, it will list blobs from the beginning. Only blobs that begin with the input prefix will be listed.

Any number of blobs can be listed, from zero up to a set maximum. Even if this method returns zero results, if the AZSContinuationToken in the result is not nil, there may be more blobs on the service that have not been listed.

Declared In

AZSCloudBlobDirectory.h