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++.
Public Member Functions | List of all members
azure::storage::cloud_blob_properties Class Reference

Represents the system properties for a blob. More...

Public Member Functions

 cloud_blob_properties ()
 Initializes a new instance of the azure::storage::cloud_blob_properties class. More...
 
const utility::string_t & cache_control () const
 Gets the cache-control value stored for the blob. More...
 
void set_cache_control (utility::string_t value)
 Sets the cache-control value stored for the blob. More...
 
const utility::string_t & content_disposition () const
 Gets the content-disposition value stored for the blob. More...
 
void set_content_disposition (utility::string_t value)
 Sets the content-disposition value stored for the blob. More...
 
const utility::string_t & content_encoding () const
 Gets the content-encoding value stored for the blob. More...
 
void set_content_encoding (utility::string_t value)
 Sets the content-encoding value stored for the blob. More...
 
const utility::string_t & content_language () const
 Gets the content-language value stored for the blob. More...
 
void set_content_language (utility::string_t value)
 Sets the content-language value stored for the blob. More...
 
utility::size64_t size () const
 Gets the size of the blob, in bytes. More...
 
const utility::string_t & content_md5 () const
 Gets the content-MD5 value stored for the blob. More...
 
void set_content_md5 (utility::string_t value)
 Sets the content-MD5 value stored for the blob. More...
 
const utility::string_t & content_type () const
 Gets the content-type value stored for the blob. More...
 
void set_content_type (utility::string_t value)
 Sets the content-type value stored for the blob. More...
 
const utility::string_t & etag () const
 Gets the blob's ETag value. More...
 
const utility::string_t & encryption_key_sha256 () const
 Gets the SHA-256 of the customer-provided key used to encrypt this blob. More...
 
utility::datetime last_modified () const
 Gets the last-modified time for the blob, expressed as a UTC value. More...
 
blob_type type () const
 Gets the type of the blob. More...
 
azure::storage::lease_status lease_status () const
 Gets the blob's lease status. More...
 
azure::storage::lease_state lease_state () const
 Gets the blob's lease state. More...
 
azure::storage::lease_duration lease_duration () const
 Gets the blob's lease duration. More...
 
int64_t page_blob_sequence_number () const
 If the blob is a page blob, gets the blob's current sequence number. More...
 
int append_blob_committed_block_count () const
 If the blob is an append blob, gets the number of committed blocks. More...
 
bool server_encrypted () const
 Gets server encryption states. More...
 
bool is_incremental_copy () const
 Gets a value indicating whether or not this blob is an incremental copy. More...
 
azure::storage::standard_blob_tier standard_blob_tier () const
 Gets a value indicating the standard blob tier if the blob is a block blob. More...
 
azure::storage::premium_blob_tier premium_blob_tier () const
 Gets a value indicating the premium blob tier if the blob is a page blob. More...
 
azure::storage::archive_status archive_status () const
 Gets a value indicating the archive status of the blob. More...
 
bool access_tier_inferred () const
 Gets a value indicating whether or not the access tier is inferred. More...
 
utility::datetime access_tier_change_time () const
 Gets the access tier change time for the blob, expressed as a UTC value. More...
 
const utility::string_t & version_id () const
 Gets the version id of the blob. More...
 

Detailed Description

Represents the system properties for a blob.

Constructor & Destructor Documentation

◆ cloud_blob_properties()

azure::storage::cloud_blob_properties::cloud_blob_properties ( )
inline

Initializes a new instance of the azure::storage::cloud_blob_properties class.

Member Function Documentation

◆ access_tier_change_time()

utility::datetime azure::storage::cloud_blob_properties::access_tier_change_time ( ) const
inline

Gets the access tier change time for the blob, expressed as a UTC value.

Returns
The access tier change time, in UTC format.

◆ access_tier_inferred()

bool azure::storage::cloud_blob_properties::access_tier_inferred ( ) const
inline

Gets a value indicating whether or not the access tier is inferred.

Returns
true if the access tier is not explicitly set on a page blob on premium accounts; otherwise, false.

◆ append_blob_committed_block_count()

int azure::storage::cloud_blob_properties::append_blob_committed_block_count ( ) const
inline

If the blob is an append blob, gets the number of committed blocks.

Returns
The number of committed blocks

◆ archive_status()

azure::storage::archive_status azure::storage::cloud_blob_properties::archive_status ( ) const
inline

Gets a value indicating the archive status of the blob.

Returns
An azure::storage::archive_status object that indicates the blob's archive status.

◆ cache_control()

const utility::string_t& azure::storage::cloud_blob_properties::cache_control ( ) const
inline

Gets the cache-control value stored for the blob.

Returns
The blob's cache-control value.

◆ content_disposition()

const utility::string_t& azure::storage::cloud_blob_properties::content_disposition ( ) const
inline

Gets the content-disposition value stored for the blob.

Returns
The blob's content-disposition value.

◆ content_encoding()

const utility::string_t& azure::storage::cloud_blob_properties::content_encoding ( ) const
inline

Gets the content-encoding value stored for the blob.

Returns
The blob's content-encoding value.

◆ content_language()

const utility::string_t& azure::storage::cloud_blob_properties::content_language ( ) const
inline

Gets the content-language value stored for the blob.

Returns
The blob's content-language value.

◆ content_md5()

const utility::string_t& azure::storage::cloud_blob_properties::content_md5 ( ) const
inline

Gets the content-MD5 value stored for the blob.

Returns
The blob's content-MD5 hash.

◆ content_type()

const utility::string_t& azure::storage::cloud_blob_properties::content_type ( ) const
inline

Gets the content-type value stored for the blob.

Returns
The blob's content-type value.

◆ encryption_key_sha256()

const utility::string_t& azure::storage::cloud_blob_properties::encryption_key_sha256 ( ) const
inline

Gets the SHA-256 of the customer-provided key used to encrypt this blob.

Returns
The base64-encoded SHA-256 value.

◆ etag()

const utility::string_t& azure::storage::cloud_blob_properties::etag ( ) const
inline

Gets the blob's ETag value.

Returns
The blob's ETag value.

◆ is_incremental_copy()

bool azure::storage::cloud_blob_properties::is_incremental_copy ( ) const
inline

Gets a value indicating whether or not this blob is an incremental copy.

Returns
true if the blob is an incremental copy; otherwise, false.

◆ last_modified()

utility::datetime azure::storage::cloud_blob_properties::last_modified ( ) const
inline

Gets the last-modified time for the blob, expressed as a UTC value.

Returns
The blob's last-modified time, in UTC format.

◆ lease_duration()

azure::storage::lease_duration azure::storage::cloud_blob_properties::lease_duration ( ) const
inline

Gets the blob's lease duration.

Returns
An azure::storage::lease_duration object that indicates the blob's lease duration.

◆ lease_state()

azure::storage::lease_state azure::storage::cloud_blob_properties::lease_state ( ) const
inline

Gets the blob's lease state.

Returns
An azure::storage::lease_state object that indicates the blob's lease state.

◆ lease_status()

azure::storage::lease_status azure::storage::cloud_blob_properties::lease_status ( ) const
inline

Gets the blob's lease status.

Returns
An azure::storage::lease_status object that indicates the blob's lease status.

◆ page_blob_sequence_number()

int64_t azure::storage::cloud_blob_properties::page_blob_sequence_number ( ) const
inline

If the blob is a page blob, gets the blob's current sequence number.

Returns
The blob's current sequence number.

◆ premium_blob_tier()

azure::storage::premium_blob_tier azure::storage::cloud_blob_properties::premium_blob_tier ( ) const
inline

Gets a value indicating the premium blob tier if the blob is a page blob.

Returns
An azure::storage::premium_blob_tier enum that indicates the blob's tier.

◆ server_encrypted()

bool azure::storage::cloud_blob_properties::server_encrypted ( ) const
inline

Gets server encryption states.

Returns
true if the blob is encrypted on server side; otherwise, false.

◆ set_cache_control()

void azure::storage::cloud_blob_properties::set_cache_control ( utility::string_t  value)
inline

Sets the cache-control value stored for the blob.

Parameters
valueThe blob's cache-control value.

◆ set_content_disposition()

void azure::storage::cloud_blob_properties::set_content_disposition ( utility::string_t  value)
inline

Sets the content-disposition value stored for the blob.

Parameters
valueThe blob's content-disposition value.

◆ set_content_encoding()

void azure::storage::cloud_blob_properties::set_content_encoding ( utility::string_t  value)
inline

Sets the content-encoding value stored for the blob.

Parameters
valueThe blob's content-encoding value.

◆ set_content_language()

void azure::storage::cloud_blob_properties::set_content_language ( utility::string_t  value)
inline

Sets the content-language value stored for the blob.

Parameters
valueThe blob's content-language value.

◆ set_content_md5()

void azure::storage::cloud_blob_properties::set_content_md5 ( utility::string_t  value)
inline

Sets the content-MD5 value stored for the blob.

Parameters
valueThe blob's content-MD5 hash.

◆ set_content_type()

void azure::storage::cloud_blob_properties::set_content_type ( utility::string_t  value)
inline

Sets the content-type value stored for the blob.

Parameters
valueThe blob's content-type value.

◆ size()

utility::size64_t azure::storage::cloud_blob_properties::size ( ) const
inline

Gets the size of the blob, in bytes.

Returns
The blob's size in bytes.

◆ standard_blob_tier()

azure::storage::standard_blob_tier azure::storage::cloud_blob_properties::standard_blob_tier ( ) const
inline

Gets a value indicating the standard blob tier if the blob is a block blob.

Returns
An azure::storage::standard_blob_tier enum that indicates the blob's tier.

◆ type()

blob_type azure::storage::cloud_blob_properties::type ( ) const
inline

Gets the type of the blob.

Returns
An azure::storage::blob_type object that indicates the type of the blob.

◆ version_id()

const utility::string_t& azure::storage::cloud_blob_properties::version_id ( ) const
inline

Gets the version id of the blob.

Returns
The version id the blob refers to.