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

Classes

struct  inherit_t
 
struct  now_t
 
struct  preserve_t
 

Public Member Functions

 cloud_file_directory_properties ()
 Initializes a new instance of the azure::storage::cloud_file_directory_properties class. More...
 
const utility::string_t & etag () const
 Gets the directory's ETag value. More...
 
utility::datetime last_modified () const
 Gets the last-modified time for the directory, expressed as a UTC value. More...
 
bool server_encrypted ()
 Gets if the server is encrypted. More...
 
void set_server_encrypted (bool value)
 Sets if the server is encrypted. More...
 
const utility::string_t & permission () const
 Gets the permission property. More...
 
void set_permission (utility::string_t value)
 Sets the permission property. More...
 
void set_permission (inherit_t)
 Sets the permission property value to inherit, which means to inherit from the parent directory. More...
 
void set_permission (preserve_t)
 Sets the permission property value to preserve, which means to keep existing value unchanged. More...
 
const utility::string_t & permission_key () const
 Gets security descriptor of the permission. More...
 
void set_permission_key (utility::string_t value)
 Sets security descriptor of permission. More...
 
cloud_file_attributes attributes () const
 Gets file system attributes set on this directory. More...
 
void set_attributes (cloud_file_attributes value)
 Sets file system attributes on this directory. More...
 
utility::datetime creation_time () const
 Gets the creation time property for this directory. More...
 
void set_creation_time (utility::datetime value)
 Sets the creation time property for this directory. More...
 
void set_creation_time (now_t)
 Sets the creation time property for this directory to now, which indicates the time of the request. More...
 
void set_creation_time (preserve_t)
 Sets the creation time property for this directory to preserve, which means to keep the existing value unchanged. More...
 
utility::datetime last_write_time () const
 Gets the last write time property for this directory. More...
 
void set_last_write_time (utility::datetime value)
 Sets the last write time property for this directory. More...
 
void set_last_write_time (now_t)
 Sets the last write time property for this directory to now, which indicates the time of the request. More...
 
void set_last_write_time (preserve_t)
 Sets the last write time property for this directory to preserve, which means to keep the existing value unchanged. More...
 
utility::datetime chang_time () const
 Gets the change time property for this directory. More...
 
const utility::string_t & file_id () const
 Gets the file id property for this directory. More...
 
const utility::string_t & file_parent_id () const
 Gets the parent file id property for this directory. More...
 

Static Public Attributes

static constexpr now_t now {}
 
static constexpr inherit_t inherit {}
 
static constexpr preserve_t preserve {}
 

Constructor & Destructor Documentation

◆ cloud_file_directory_properties()

azure::storage::cloud_file_directory_properties::cloud_file_directory_properties ( )
inline

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

Member Function Documentation

◆ attributes()

cloud_file_attributes azure::storage::cloud_file_directory_properties::attributes ( ) const
inline

Gets file system attributes set on this directory.

Returns
An azure::storage::cloud_file_attributes that represents a set of attributes.

◆ chang_time()

utility::datetime azure::storage::cloud_file_directory_properties::chang_time ( ) const
inline

Gets the change time property for this directory.

Returns
An ISO 8601 datetime utility::string_t.

◆ creation_time()

utility::datetime azure::storage::cloud_file_directory_properties::creation_time ( ) const
inline

Gets the creation time property for this directory.

Returns
An ISO 8601 datetime utility::string_t.

◆ etag()

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

Gets the directory's ETag value.

Returns
The directory's ETag value.

◆ file_id()

const utility::string_t& azure::storage::cloud_file_directory_properties::file_id ( ) const
inline

Gets the file id property for this directory.

Returns
A utility::string_t contains the file id.

◆ file_parent_id()

const utility::string_t& azure::storage::cloud_file_directory_properties::file_parent_id ( ) const
inline

Gets the parent file id property for this directory.

Returns
A utility::string_t contains the parent file id.

◆ last_modified()

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

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

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

◆ last_write_time()

utility::datetime azure::storage::cloud_file_directory_properties::last_write_time ( ) const
inline

Gets the last write time property for this directory.

Returns
An ISO 8601 datetime utility::string_t.

◆ permission()

const utility::string_t& azure::storage::cloud_file_directory_properties::permission ( ) const
inline

Gets the permission property.

Returns
A utility::string_t object that contains permission in the Security Descriptor Definition Language(SDDL).

◆ permission_key()

const utility::string_t& azure::storage::cloud_file_directory_properties::permission_key ( ) const
inline

Gets security descriptor of the permission.

Returns
A utility::string_t that contains security descriptor of the permission.

◆ server_encrypted()

bool azure::storage::cloud_file_directory_properties::server_encrypted ( )
inline

Gets if the server is encrypted.

Returns
true if a server is encrypted.

◆ set_attributes()

void azure::storage::cloud_file_directory_properties::set_attributes ( cloud_file_attributes  value)
inline

Sets file system attributes on this directory.

Parameters
valueAn azure::storage::cloud_file_attributes that represents a set of attributes.

◆ set_creation_time() [1/3]

void azure::storage::cloud_file_directory_properties::set_creation_time ( utility::datetime  value)
inline

Sets the creation time property for this directory.

Parameters
valueAn ISO 8601 datetime utility::string_t.

◆ set_creation_time() [2/3]

void azure::storage::cloud_file_directory_properties::set_creation_time ( now_t  )
inline

Sets the creation time property for this directory to now, which indicates the time of the request.

Parameters
valueExplicitly specified datetime value, must be azure::storage::cloud_file_directory_properties::now.

◆ set_creation_time() [3/3]

void azure::storage::cloud_file_directory_properties::set_creation_time ( preserve_t  )
inline

Sets the creation time property for this directory to preserve, which means to keep the existing value unchanged.

Parameters
valueExplicitly specified datetime value, must be azure::storage::cloud_file_directory_properties::preserve.

◆ set_last_write_time() [1/3]

void azure::storage::cloud_file_directory_properties::set_last_write_time ( utility::datetime  value)
inline

Sets the last write time property for this directory.

Parameters
valueAn ISO 8601 datetime utility::string_t.

◆ set_last_write_time() [2/3]

void azure::storage::cloud_file_directory_properties::set_last_write_time ( now_t  )
inline

Sets the last write time property for this directory to now, which indicates the time of the request.

Parameters
valueExplicitly specified datetime value, must be azure::storage::cloud_file_directory_properties::now.

◆ set_last_write_time() [3/3]

void azure::storage::cloud_file_directory_properties::set_last_write_time ( preserve_t  )
inline

Sets the last write time property for this directory to preserve, which means to keep the existing value unchanged.

Parameters
valueExplicitly specified datetime value, must be azure::storage::cloud_file_directory_properties::preserve.

◆ set_permission() [1/3]

void azure::storage::cloud_file_directory_properties::set_permission ( utility::string_t  value)
inline

Sets the permission property.

Parameters
valueA utility::string_t that contains permission in the Security Descriptor Definition Language (SDDL).

◆ set_permission() [2/3]

void azure::storage::cloud_file_directory_properties::set_permission ( inherit_t  )
inline

Sets the permission property value to inherit, which means to inherit from the parent directory.

Parameters
valueExplicitly specified permission value, must be azure::storage::cloud_file_directory_properties::inherit.

◆ set_permission() [3/3]

void azure::storage::cloud_file_directory_properties::set_permission ( preserve_t  )
inline

Sets the permission property value to preserve, which means to keep existing value unchanged.

Parameters
valueExplicitly specified permission value, must be azure::storage::cloud_file_directory_properties::preserve.

◆ set_permission_key()

void azure::storage::cloud_file_directory_properties::set_permission_key ( utility::string_t  value)
inline

Sets security descriptor of permission.

Parameters
valueA utility::string_t that contains security descriptor of the permission.

◆ set_server_encrypted()

void azure::storage::cloud_file_directory_properties::set_server_encrypted ( bool  value)
inline

Sets if the server is encrypted.

Parameters
valueIf the server is encrypted.