AZSAccessCondition Class Reference

Inherits from	NSObject
Declared in	AZSAccessCondition.h AZSAccessCondition.m

Overview

An AZSAccessCondition represents a condition that can be used for blob requests.

An AZSAccessCondition can be used to restrict blob requests - the request will fail unless the condition is met. This is primarily used for parallel / synchronizing scenarios - you can specify (for example) that the request should only succeed if the blob has not been modified since the specified date/time, or if the blob matches a given etag. Only one access condition can be set for a given request, not including the lease ID. (This is a limitation of the library, not the Storage Service.)

`ifMatchETag`

The ETag to match. The service will fail the request if the ETag doesn’t match. Use “*” to match any ETag, as long as the object already exists on the service.

@property (copy, readonly, AZSNullable) NSString *ifMatchETag

Discussion

The ETag to match. The service will fail the request if the ETag doesn’t match. Use “*” to match any ETag, as long as the object already exists on the service.

Declared In

AZSAccessCondition.h

`ifNoneMatchETag`

The ETag to not match. The service will fail the request if the ETag matches this. Use “*” to match any ETag, as long as the object already exists on the service.

@property (copy, readonly, AZSNullable) NSString *ifNoneMatchETag

Discussion

The ETag to not match. The service will fail the request if the ETag matches this. Use “*” to match any ETag, as long as the object already exists on the service.

Declared In

AZSAccessCondition.h

`ifModifiedSinceDate`

The request will fail if the object has not been modified since this date.

@property (copy, readonly, AZSNullable) NSDate *ifModifiedSinceDate

Discussion

The request will fail if the object has not been modified since this date.

Declared In

AZSAccessCondition.h

`ifNotModifiedSinceDate`

The request will fail if the object has been modified since this date.

@property (copy, readonly, AZSNullable) NSDate *ifNotModifiedSinceDate

Discussion

The request will fail if the object has been modified since this date.

Declared In

AZSAccessCondition.h

`leaseId`

The lease ID for this request.

@property (copy, AZSNullable) NSString *leaseId

Discussion

The lease ID for this request.

Declared In

AZSAccessCondition.h

`sequenceNumber`

The sequence number to compare using the sequenceNumberOperator. The request will fail if the comparison fails. Page blobs only.

@property (copy, readonly, AZSNullable) NSNumber *sequenceNumber

Discussion

The sequence number to compare using the sequenceNumberOperator. The request will fail if the comparison fails. Page blobs only.

Declared In

AZSAccessCondition.h

`sequenceNumberOperator`

The operator to use to compare the sequence number here and the one on the service. Page blobs only.

@property AZSSequenceNumberOperator sequenceNumberOperator

Discussion

The operator to use to compare the sequence number here and the one on the service. Page blobs only.

Declared In

AZSAccessCondition.h

`maxSize`

The request will fail if the append blob will be greater than this after the append operation. Append block API only.

@property (copy, AZSNullable) NSNumber *maxSize

Discussion

The request will fail if the append blob will be greater than this after the append operation. Append block API only.

Declared In

AZSAccessCondition.h

`appendPosition`

The request will fail if the append position before appending the current block is not equal to this. Append block API only.

@property (copy, AZSNullable) NSNumber *appendPosition

Discussion

The request will fail if the append position before appending the current block is not equal to this. Append block API only.

Declared In

AZSAccessCondition.h

`– initWithIfMatchCondition:`

Initialize a new AZSAccessCondition object with a ‘If-Match’ condition.

- (instancetype)initWithIfMatchCondition:(NSString *__AZSNullable)eTag

Parameters

`eTag`	The ETag that must match on the service; otherwise the request will fail.

Discussion

Initialize a new AZSAccessCondition object with a ‘If-Match’ condition.

Declared In

AZSAccessCondition.h

`– initWithIfNoneMatchCondition:`

Initialize a new AZSAccessCondition object with a ‘If-None-Match’ condition.

- (instancetype)initWithIfNoneMatchCondition:(NSString *)eTag

Parameters

`eTag`	The ETag that must not match on the service; otherwise the request will fail.

Discussion

Initialize a new AZSAccessCondition object with a ‘If-None-Match’ condition.

Declared In

AZSAccessCondition.h

`– initWithIfModifiedSinceCondition:`

Initialize a new AZSAccessCondition object with a ‘If-Modified-Since’ condition.

- (instancetype)initWithIfModifiedSinceCondition:(NSDate *)modifiedDate

Parameters

`modifiedDate`	The object on the service must have been modified since this time, otherwise the request will fail.

Discussion

Initialize a new AZSAccessCondition object with a ‘If-Modified-Since’ condition.

Declared In

AZSAccessCondition.h

`– initWithIfNotModifiedSinceCondition:`

Initialize a new AZSAccessCondition object with a ‘If-Not-Modified-Since’ condition.

- (instancetype)initWithIfNotModifiedSinceCondition:(NSDate *)modifiedDate

Parameters

`modifiedDate`	The object on the service must not have been modified since this time, otherwise the request will fail.

Discussion

Initialize a new AZSAccessCondition object with a ‘If-Not-Modified-Since’ condition.

Declared In

AZSAccessCondition.h

`– initWithIfSequenceNumberLessThanOrEqualTo:`

Initialize a new AZSAccessCondition object with a ‘If-Sequence-Number-Less-Than-Or-Equal-To’ condition.

- (instancetype)initWithIfSequenceNumberLessThanOrEqualTo:(NSNumber *)sequenceNumber

Discussion

Initialize a new AZSAccessCondition object with a ‘If-Sequence-Number-Less-Than-Or-Equal-To’ condition.

Declared In

AZSAccessCondition.h

`– initWithIfSequenceNumberLessThan:`

Initialize a new AZSAccessCondition object with a ‘If-Sequence-Number-Less-Than’ condition.

- (instancetype)initWithIfSequenceNumberLessThan:(NSNumber *)sequenceNumber

Discussion

Initialize a new AZSAccessCondition object with a ‘If-Sequence-Number-Less-Than’ condition.

Declared In

AZSAccessCondition.h

`– initWithIfSequenceNumberEqualTo:`

Initialize a new AZSAccessCondition object with a ‘If-Sequence-Number-Equal-To’ condition.

- (instancetype)initWithIfSequenceNumberEqualTo:(NSNumber *)sequenceNumber

Discussion

Initialize a new AZSAccessCondition object with a ‘If-Sequence-Number-Equal-To’ condition.

Declared In

AZSAccessCondition.h

`– initWithIfMaxSizeLessThanOrEqualTo:`

Initialize a new AZSAccessCondition object with a ‘If-Max-Size-Less-Than-Or-Equal-To’ condition.

- (instancetype)initWithIfMaxSizeLessThanOrEqualTo:(NSNumber *)maxSize

Discussion

Initialize a new AZSAccessCondition object with a ‘If-Max-Size-Less-Than-Or-Equal-To’ condition.

Declared In

AZSAccessCondition.h

`– initWithIfAppendPositionEqualTo:`

Initialize a new AZSAccessCondition object with a ‘If-Append-Position-Equal-To’ condition.

- (instancetype)initWithIfAppendPositionEqualTo:(NSNumber *)appendPosition

Discussion

Initialize a new AZSAccessCondition object with a ‘If-Append-Position-Equal-To’ condition.

Declared In

AZSAccessCondition.h

`– initWithLeaseId:`

Initialize a new AZSAccessCondition object with a lease ID. Note that if you wish to specify both a lease ID and another access condition, you must use one of the other initializers, and then specify the lease ID afterwards.

- (instancetype)initWithLeaseId:(NSString *)leaseId

Parameters

`leaseId`	The lease ID to specify for the request.

Discussion

Declared In

AZSAccessCondition.h