AZSCloudBlobClient Class Reference

Inherits from AZSCloudClient : NSObject
Declared in AZSCloudBlobClient.h
AZSCloudBlobClient.m

Overview

The AZSCloudBlobClient represents a the blob service for a given storage account.

The AZSCloudBlobClient is used to perform service-level operations, including listing containers and (forthcoming) setting service-level properties.

  defaultRequestOptions

The default AZSBlobRequestOptions to use for all service calls made from this client.

@property (strong, AZSNullable) AZSBlobRequestOptions *defaultRequestOptions

Discussion

The default AZSBlobRequestOptions to use for all service calls made from this client.

If you make a service call with the library and either do not provide an AZSBlobRequestOptions object, or do not set some subset of the options, the options set in this object will be used as defaults. This object is used for both calls made on this client object, and calls made with AZSCloudBlobContainer and AZSCloudBlob objects created from this AZSCloudBlobClient object.

Declared In

AZSCloudBlobClient.h

  directoryDelimiter

The delimiter to use to separate out blob directories.

@property (strong) NSString *directoryDelimiter

Discussion

The delimiter to use to separate out blob directories.

Declared In

AZSCloudBlobClient.h

– containerReferenceFromName:

Initialize a local AZSCloudBlobContainer object

- (AZSCloudBlobContainer *)containerReferenceFromName:(NSString *)containerName

Parameters

containerName

The name of the container (part of the URL)

Return Value

The new container object.

Discussion

Initialize a local AZSCloudBlobContainer object

This creates an AZSCloudBlobContainer object with the input name.

TODO: Consider renaming this ‘containerFromName’. This is better Objective-C style, but may confuse users into thinking that this method creates a container 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 container, this will not be reflected in the local container object.

Declared In

AZSCloudBlobClient.h

– listContainersSegmentedWithContinuationToken:completionHandler:

Performs one segmented container listing operation.

- (void)listContainersSegmentedWithContinuationToken:(AZSNullable AZSContinuationToken *)continuationToken completionHandler:(void ( ^ ) ( NSError *__AZSNullable , AZSContainerResultSegment *__AZSNullable ))completionHandler

Parameters

continuationToken

The token representing where the listing operation should start.
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.
AZSContainerResultSegment * The result segment containing the result of the listing operation.

Discussion

Performs one segmented container listing operation.

This method lists the containers on the blob service for the associated account. It will perform exactly one REST call, which will list containers beginning with the container represented in the AZSContinuationToken. If no token is provided, it will list containers from the beginning.

Any number of containers 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 containers on the service that have not been listed.

Declared In

AZSCloudBlobClient.h

– listContainersSegmentedWithContinuationToken:prefix:completionHandler:

Performs one segmented container listing operation.

- (void)listContainersSegmentedWithContinuationToken:(AZSNullable AZSContinuationToken *)continuationToken prefix:(AZSNullable NSString *)prefix completionHandler:(void ( ^ ) ( NSError *__AZSNullable , AZSContainerResultSegment *__AZSNullable ))completionHandler

Parameters

continuationToken

The token representing where the listing operation should start.
prefix

The prefix to use for container listing. Only containers that begin with the input prefix will be listed.
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.
AZSContainerResultSegment * The result segment containing the result of the listing operation.

Discussion

Performs one segmented container listing operation.

This method lists the containers on the blob service for the associated account. It will perform exactly one REST call, which will list containers beginning with the container represented in the AZSContinuationToken. If no token is provided, it will list containers from the beginning. Only containers that begin with the input prefix will be listed.

Any number of containers 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 containers on the service that have not been listed.

Declared In

AZSCloudBlobClient.h

– listContainersSegmentedWithContinuationToken:prefix:containerListingDetails:maxResults:completionHandler:

Performs one segmented container listing operation.

- (void)listContainersSegmentedWithContinuationToken:(AZSNullable AZSContinuationToken *)continuationToken prefix:(AZSNullable NSString *)prefix containerListingDetails:(AZSContainerListingDetails)containerListingDetails maxResults:(NSInteger)maxResults completionHandler:(void ( ^ ) ( NSError *__AZSNullable , AZSContainerResultSegment *__AZSNullable ))completionHandler

Parameters

continuationToken

The token representing where the listing operation should start.
prefix

The prefix to use for container listing. Only containers that begin with the input prefix will be listed.
containerListingDetails

Any additional data that should be returned in the listing operation.
maxResults

The maximum number of results to return. The service will return up to this number of results.
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.
AZSContainerResultSegment * The result segment containing the result of the listing operation.

Discussion

Performs one segmented container listing operation.

This method lists the containers on the blob service for the associated account. It will perform exactly one REST call, which will list containers beginning with the container represented in the AZSContinuationToken. If no token is provided, it will list containers from the beginning. Only containers that begin with the input prefix will be listed.

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

Declared In

AZSCloudBlobClient.h

– listContainersSegmentedWithContinuationToken:prefix:containerListingDetails:maxResults:requestOptions:operationContext:completionHandler:

Performs one segmented container listing operation.

- (void)listContainersSegmentedWithContinuationToken:(AZSNullable AZSContinuationToken *)continuationToken prefix:(AZSNullable NSString *)prefix containerListingDetails:(AZSContainerListingDetails)containerListingDetails maxResults:(NSInteger)maxResults requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , AZSContainerResultSegment *__AZSNullable ))completionHandler

Parameters

continuationToken

The token representing where the listing operation should start.
prefix

The prefix to use for container listing. Only containers that begin with the input prefix will be listed.
containerListingDetails

Any additional data that should be returned in the listing operation.
maxResults

The maximum number of results to return. The service will return up to this number of results.
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.
AZSContainerResultSegment * The result segment containing the result of the listing operation.

Discussion

Performs one segmented container listing operation.

This method lists the containers on the blob service for the associated account. It will perform exactly one REST call, which will list containers beginning with the container represented in the AZSContinuationToken. If no token is provided, it will list containers from the beginning. Only containers that begin with the input prefix will be listed.

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

Declared In

AZSCloudBlobClient.h

– uploadServicePropertiesWithServiceProperties:completionHandler:

Uploads service properties.

- (void)uploadServicePropertiesWithServiceProperties:(AZSServiceProperties *)serviceProperties completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

serviceProperties

The service properties to upload.
completionHandler

The block of code to execute when the Upload Permissions call completes.

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

Discussion

Uploads service properties.

Declared In

AZSCloudBlobClient.h

– uploadServicePropertiesWithServiceProperties:requestOptions:operationContext:completionHandler:

Uploads service properties.

- (void)uploadServicePropertiesWithServiceProperties:(AZSServiceProperties *)serviceProperties requestOptions:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable ))completionHandler

Parameters

serviceProperties

The service properties to upload.
requestOptions

Specifies any additional options for the request. Specifying nil will use the default request options from the associated client.
operationContext

Represents the context for the current operation. Can be used to track requests to the storage service, and to provide additional runtime information about the operation.
completionHandler

The block of code to execute when the Upload Service Properties call completes.

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

Discussion

Uploads service properties.

Declared In

AZSCloudBlobClient.h

– downloadServicePropertiesWithCompletionHandler:

Retrieves the stored service properties.

- (void)downloadServicePropertiesWithCompletionHandler:(void ( ^ ) ( NSError *__AZSNullable , AZSServiceProperties *__AZSNullable ))completionHandler

Parameters

completionHandler

The block of code to execute when the Download Service Properties call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
AZSServiceProperties * The resulting service properties returned from the get service properties operation.

Discussion

Retrieves the stored service properties.

Declared In

AZSCloudBlobClient.h

– downloadServicePropertiesWithCompletionHandler:operationContext:completionHandler:

Retrieves the stored service properties.

- (void)downloadServicePropertiesWithCompletionHandler:(AZSNullable AZSBlobRequestOptions *)requestOptions operationContext:(AZSNullable AZSOperationContext *)operationContext completionHandler:(void ( ^ ) ( NSError *__AZSNullable , AZSServiceProperties *__AZSNullable ))completionHandler

Parameters

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 Download Service Properties call completes.

Parameter name Description
NSError * Nil if the operation succeeded without error, error with details about the failure otherwise.
AZSServiceProperties * The resulting service properties returned from the get service properties operation.

Discussion

Retrieves the stored service properties.

Declared In

AZSCloudBlobClient.h