Microsoft Azure Storage Client Library for C++
7.5.0
The Microsoft Azure Storage Client Library for C++ is a library for working with the Azure Storage Services in C++.
|
Represents a set of access conditions to be used for operations against the Blob service. More...
Public Types | |
enum | sequence_number_operators { sequence_number_operators::none, sequence_number_operators::le, sequence_number_operators::lt, sequence_number_operators::eq } |
Describes the set of operators for comparing the blob's sequence number with the specified value. More... | |
Public Member Functions | |
access_condition () | |
Constructs an empty access condition. More... | |
const utility::string_t & | if_match_etag () const |
Gets an ETag value that must match the ETag of a resource. More... | |
void | set_if_match_etag (utility::string_t value) |
Sets an ETag that must match the ETag of a resource. More... | |
const utility::string_t & | if_none_match_etag () const |
Gets an ETag that must not match the ETag of a resource. More... | |
void | set_if_none_match_etag (utility::string_t value) |
Sets an ETag that must not match the ETag of a resource. More... | |
utility::datetime | if_modified_since_time () const |
Gets a time that must be before the last-modified time of a resource. More... | |
void | set_if_modified_since_time (utility::datetime value) |
Sets a time that must be before the last-modified time of a resource. More... | |
utility::datetime | if_not_modified_since_time () const |
Gets a time that must not be before the last-modified time of a resource. More... | |
void | set_if_not_modified_since_time (utility::datetime value) |
Sets a time that must not be before the last-modified time of a resource. More... | |
void | set_if_sequence_number_less_than_or_equal (int64_t value) |
Sets a sequence number that the current sequence number of a page blob must be less than or equal to in order for the operation to proceed. More... | |
void | set_if_sequence_number_less_than (int64_t value) |
Sets a sequence number that the current sequence number of a page blob must be less than in order for the operation to proceed. More... | |
void | set_if_sequence_number_equal (int64_t value) |
Sets a sequence number that the current sequence number of a page blob must be equal to in order for the operation to proceed. More... | |
int64_t | sequence_number () const |
Gets a sequence number that the current sequence number of a page blob must be equal to in order for the operation to proceed. More... | |
sequence_number_operators | sequence_number_operator () const |
Gets the sequence number comparison operator specified for the access condition. More... | |
int64_t | max_size () const |
Gets a number that indicates the maximum size in bytes to restrict the blob to when commiting the block. More... | |
void | set_max_size (int64_t value) |
Sets a number that indicates the maximum size in bytes to restrict the blob to when commiting the block. More... | |
int64_t | append_position () const |
Gets an append position that the end position of an append blob must be equal to in order for the operation to proceed. More... | |
void | set_append_position (int64_t value) |
Sets the append position that the end position of an append blob must be equal to in order for the operation to proceed. More... | |
const utility::string_t & | lease_id () const |
Gets a lease ID that must match the lease on a resource. More... | |
void | set_lease_id (utility::string_t value) |
Sets a lease ID that must match the lease on a resource. More... | |
bool | is_conditional () const |
Indicates whether the azure::storage::access_condition object specifies a condition. More... | |
Static Public Member Functions | |
static access_condition | generate_empty_condition () |
Generates an empty access condition. More... | |
static access_condition | generate_if_not_exists_condition () |
Generates an access condition such that an operation will be performed only if the resource does not exist on the service. More... | |
static access_condition | generate_if_exists_condition () |
Generates an access condition such that an operation will be performed only if the resource exists on the service. More... | |
static access_condition | generate_if_match_condition (utility::string_t etag) |
Generates an access condition such that an operation will be performed only if the resource's ETag value matches the specified ETag value. More... | |
static access_condition | generate_if_modified_since_condition (utility::datetime modified_time) |
Generates an access condition such that an operation will be performed only if the resource has been modified since the specified time. More... | |
static access_condition | generate_if_none_match_condition (utility::string_t etag) |
Generates an access condition such that an operation will be performed only if the resource's ETag value does not match the specified ETag value. More... | |
static access_condition | generate_if_not_modified_since_condition (utility::datetime modified_time) |
Generates an access condition such that an operation will be performed only if the resource has not been modified since the specified time. More... | |
static access_condition | generate_if_sequence_number_less_than_or_equal_condition (int64_t sequence_number) |
Generates an access condition such that an operation will be performed only if resource's current sequence number is less than or equal to the specified value. More... | |
static access_condition | generate_if_sequence_number_less_than_condition (int64_t sequence_number) |
Generates an access condition such that an operation will be performed only if resource's current sequence number is less than the specified value. More... | |
static access_condition | generate_if_sequence_number_equal_condition (int64_t sequence_number) |
Generates an access condition such that an operation will be performed only if resource's current sequence number is equal to the specified value. More... | |
static access_condition | generate_lease_condition (utility::string_t lease_id) |
Generates an access condition such that an operation will be performed only if the lease ID on the resource matches the specified lease ID. More... | |
static access_condition | generate_if_max_size_less_than_or_equal_condition (int64_t max_size) |
Generates an access condition such that an operation will be performed only if the size of the blob after committing the block is less than or equal to the specified value. More... | |
static access_condition | generate_if_append_position_equal_condition (int64_t append_position) |
Generates an access condition such that an operation will be performed only if the end position of the blob is equal to the specified value. More... | |
Represents a set of access conditions to be used for operations against the Blob service.
Describes the set of operators for comparing the blob's sequence number with the specified value.
|
inline |
Constructs an empty access condition.
|
inline |
Gets an append position that the end position of an append blob must be equal to in order for the operation to proceed.
This condition only applies to append blobs.
|
inlinestatic |
Generates an empty access condition.
|
inlinestatic |
Generates an access condition such that an operation will be performed only if the end position of the blob is equal to the specified value.
append_position | The value to compare to the current end position of the blob. |
|
inlinestatic |
Generates an access condition such that an operation will be performed only if the resource exists on the service.
Setting this access condition modifies the request to include the HTTP If-Match conditional header.
|
inlinestatic |
Generates an access condition such that an operation will be performed only if the resource's ETag value matches the specified ETag value.
etag | The ETag value that must be matched. |
|
inlinestatic |
Generates an access condition such that an operation will be performed only if the size of the blob after committing the block is less than or equal to the specified value.
max_size | The value specifying the maximum length to restrict the blob to when committing the block. |
|
inlinestatic |
Generates an access condition such that an operation will be performed only if the resource has been modified since the specified time.
modified_time | The time since which the resource must have been modified in order for the operation to proceed. |
|
inlinestatic |
Generates an access condition such that an operation will be performed only if the resource's ETag value does not match the specified ETag value.
etag | The ETag value that must be matched, or "*" . |
If "*"
is specified as the parameter then this condition requires that the resource does not exist.
|
inlinestatic |
Generates an access condition such that an operation will be performed only if the resource does not exist on the service.
Setting this access condition modifies the request to include the HTTP If-None-Match conditional header.
|
inlinestatic |
Generates an access condition such that an operation will be performed only if the resource has not been modified since the specified time.
modified_time | The time since which the resource must not have been modified in order for the operation to proceed. |
|
inlinestatic |
Generates an access condition such that an operation will be performed only if resource's current sequence number is equal to the specified value.
sequence_number | The value that the current sequence number of the resource must be equal to. |
|
inlinestatic |
Generates an access condition such that an operation will be performed only if resource's current sequence number is less than the specified value.
sequence_number | The value that the current sequence number of the resource must be less than. |
|
inlinestatic |
Generates an access condition such that an operation will be performed only if resource's current sequence number is less than or equal to the specified value.
sequence_number | The value that the current sequence number of the resource must be less than or equal to. |
|
inlinestatic |
Generates an access condition such that an operation will be performed only if the lease ID on the resource matches the specified lease ID.
lease_id | The lease ID that must match the lease ID of the resource. |
|
inline |
Gets an ETag value that must match the ETag of a resource.
|
inline |
Gets a time that must be before the last-modified time of a resource.
|
inline |
Gets an ETag that must not match the ETag of a resource.
"*"
to match any ETag.
|
inline |
Gets a time that must not be before the last-modified time of a resource.
|
inline |
Indicates whether the azure::storage::access_condition object specifies a condition.
true
if the access condition specifies a condition; otherwise, false
.
|
inline |
Gets a lease ID that must match the lease on a resource.
|
inline |
Gets a number that indicates the maximum size in bytes to restrict the blob to when commiting the block.
This condition only applies to append blobs.
|
inline |
Gets a sequence number that the current sequence number of a page blob must be equal to in order for the operation to proceed.
This condition only applies to page blobs.
|
inline |
Gets the sequence number comparison operator specified for the access condition.
|
inline |
Sets the append position that the end position of an append blob must be equal to in order for the operation to proceed.
value | An append position. |
This condition only applies to append blobs.
|
inline |
Sets an ETag that must match the ETag of a resource.
value | A string containing the ETag, in quotes. |
|
inline |
Sets a time that must be before the last-modified time of a resource.
value | A utility::datetime in UTC. |
|
inline |
Sets an ETag that must not match the ETag of a resource.
value | A quoted ETag string, or "*" to match any ETag. |
|
inline |
Sets a time that must not be before the last-modified time of a resource.
value | A utility::datetime in UTC. |
|
inline |
Sets a sequence number that the current sequence number of a page blob must be equal to in order for the operation to proceed.
value | A sequence number. |
This condition only applies to page blobs.
|
inline |
Sets a sequence number that the current sequence number of a page blob must be less than in order for the operation to proceed.
value | A sequence number. |
This condition only applies to page blobs.
|
inline |
Sets a sequence number that the current sequence number of a page blob must be less than or equal to in order for the operation to proceed.
value | A sequence number. |
This condition only applies to page blobs.
|
inline |
Sets a lease ID that must match the lease on a resource.
value | A string containing the lease ID. |
|
inline |
Sets a number that indicates the maximum size in bytes to restrict the blob to when commiting the block.
value | The maximum size in bytes. |
This condition only applies to append blobs.