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

Classes
struct	inherit_t

struct	now_t

struct	preserve_t

struct	source_t

Public Member Functions
	cloud_file_properties ()
	Initializes a new instance of the azure::storage::cloud_file_properties class. More...

utility::size64_t	length () const
	Gets the size of the file, in bytes. More...

utility::size64_t	size () const
	Gets the size of the file, in bytes. More...

const utility::string_t &	etag () const
	Gets the file's ETag value. More...

utility::datetime	last_modified () const
	Gets the last-modified time for the file, expressed as a UTC value. More...

const utility::string_t &	type () const
	Gets the type of the file. More...

const utility::string_t &	content_type () const
	Gets the content-type value stored for the file. More...

void	set_content_type (utility::string_t content_type)
	Sets the content-type value stored for the file. More...

const utility::string_t &	content_encoding () const
	Gets the content-encoding value stored for the file. More...

void	set_content_encoding (utility::string_t value)
	Sets the content-encoding value stored for the file. More...

const utility::string_t &	content_language () const
	Gets the content-language value stored for the file. More...

void	set_content_language (utility::string_t value)
	Sets the content-language value stored for the file. More...

const utility::string_t &	cache_control () const
	Gets the cache-control value stored for the file. More...

void	set_cache_control (utility::string_t value)
	Sets the cache-control value stored for the file. More...

const utility::string_t &	content_md5 () const
	Gets the content-MD5 value stored for the file. More...

void	set_content_md5 (utility::string_t value)
	Sets the content-MD5 value stored for the file. More...

const utility::string_t &	content_disposition () const
	Gets the content-disposition value stored for the file. More...

void	set_content_disposition (utility::string_t value)
	Sets the content-disposition value stored for the file. More...

bool	server_encrypted () const
	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...

void	set_permission (source_t)
	Sets the permission property value to source, which means security descriptor shall be set for the target file by copying from the source file. 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 file. More...

void	set_attributes (cloud_file_attributes value)
	Sets file system attributes on this file. More...

utility::datetime	creation_time () const
	Gets the creation time property for this file. More...

void	set_creation_time (utility::datetime value)
	Sets the creation time property for this file. More...

void	set_creation_time (now_t)
	Sets the creation time property for this file to now, which indicates the time of the request. More...

void	set_creation_time (preserve_t)
	Sets the creation time property for this file 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 file. More...

void	set_last_write_time (utility::datetime value)
	Sets the last write time property for this file. More...

void	set_last_write_time (now_t)
	Sets the last write time property for this file 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 file to preserve, which means to keep the existing value unchanged. More...

utility::datetime	change_time () const
	Gets the change time property for this file. More...

const utility::string_t &	file_id () const
	Gets the file id property for this file. More...

const utility::string_t &	file_parent_id () const
	Gets the parent file id property for this file. More...

azure::storage::lease_status	lease_status () const
	Gets the file's lease status. More...

azure::storage::lease_state	lease_state () const
	Gets the file's lease state. More...

azure::storage::lease_duration	lease_duration () const
	Gets the file's lease duration. More...

Static Public Attributes
static constexpr now_t	now {}

static constexpr inherit_t	inherit {}

static constexpr preserve_t	preserve {}

static constexpr source_t	source {}

Detailed Description

Represents the system properties for a file.

Constructor & Destructor Documentation

◆ cloud_file_properties()

azure::storage::cloud_file_properties::cloud_file_properties ( )

inline

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

Member Function Documentation

◆ attributes()

cloud_file_attributes azure::storage::cloud_file_properties::attributes ( ) const

inline

Gets file system attributes set on this file.

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

◆ cache_control()

const utility::string_t& azure::storage::cloud_file_properties::cache_control ( ) const

inline

Gets the cache-control value stored for the file.

Returns: The file's cache-control value.

◆ change_time()

utility::datetime azure::storage::cloud_file_properties::change_time ( ) const

inline

Gets the change time property for this file.

Returns: An ISO 8601 datetime utility::string_t.

◆ content_disposition()

const utility::string_t& azure::storage::cloud_file_properties::content_disposition ( ) const

inline

Gets the content-disposition value stored for the file.

Returns: The file's content-disposition value.

◆ content_encoding()

const utility::string_t& azure::storage::cloud_file_properties::content_encoding ( ) const

inline

Gets the content-encoding value stored for the file.

Returns: The file's content-encoding value.

◆ content_language()

const utility::string_t& azure::storage::cloud_file_properties::content_language ( ) const

inline

Gets the content-language value stored for the file.

Returns: The file's content-language value.

◆ content_md5()

const utility::string_t& azure::storage::cloud_file_properties::content_md5 ( ) const

inline

Gets the content-MD5 value stored for the file.

Returns: The file's content-MD5 hash.

◆ content_type()

const utility::string_t& azure::storage::cloud_file_properties::content_type ( ) const

inline

Gets the content-type value stored for the file.

Returns: The file's content-type value.

◆ creation_time()

utility::datetime azure::storage::cloud_file_properties::creation_time ( ) const

inline

Gets the creation time property for this file.

Returns: An ISO 8601 datetime utility::string_t.

◆ etag()

const utility::string_t& azure::storage::cloud_file_properties::etag ( ) const

inline

Gets the file's ETag value.

Returns: The file's ETag value.

◆ file_id()

const utility::string_t& azure::storage::cloud_file_properties::file_id ( ) const

inline

Gets the file id property for this file.

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

◆ file_parent_id()

const utility::string_t& azure::storage::cloud_file_properties::file_parent_id ( ) const

inline

Gets the parent file id property for this file.

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

◆ last_modified()

utility::datetime azure::storage::cloud_file_properties::last_modified ( ) const

inline

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

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

◆ last_write_time()

utility::datetime azure::storage::cloud_file_properties::last_write_time ( ) const

inline

Gets the last write time property for this file.

Returns: An ISO 8601 datetime utility::string_t.

◆ lease_duration()

azure::storage::lease_duration azure::storage::cloud_file_properties::lease_duration ( ) const

inline

Gets the file's lease duration.

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

◆ lease_state()

azure::storage::lease_state azure::storage::cloud_file_properties::lease_state ( ) const

inline

Gets the file's lease state.

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

◆ lease_status()

azure::storage::lease_status azure::storage::cloud_file_properties::lease_status ( ) const

inline

Gets the file's lease status.

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

◆ length()

utility::size64_t azure::storage::cloud_file_properties::length ( ) const

inline

Gets the size of the file, in bytes.

Returns: The file's size in bytes.

◆ permission()

const utility::string_t& azure::storage::cloud_file_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_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_properties::server_encrypted ( ) const

inline

Gets if the server is encrypted.

Returns: true if a server is encrypted.

◆ set_attributes()

void azure::storage::cloud_file_properties::set_attributes ( cloud_file_attributes value )

inline

Sets file system attributes on this file.

Parameters

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

◆ set_cache_control()

void azure::storage::cloud_file_properties::set_cache_control ( utility::string_t value )

inline

Sets the cache-control value stored for the file.

Parameters

value The file's cache-control value.

◆ set_content_disposition()

void azure::storage::cloud_file_properties::set_content_disposition ( utility::string_t value )

inline

Sets the content-disposition value stored for the file.

Parameters

value The file's content-disposition value.

◆ set_content_encoding()

void azure::storage::cloud_file_properties::set_content_encoding ( utility::string_t value )

inline

Sets the content-encoding value stored for the file.

Parameters

value The file's content-encoding value.

◆ set_content_language()

void azure::storage::cloud_file_properties::set_content_language ( utility::string_t value )

inline

Sets the content-language value stored for the file.

Parameters

value The file's content-language value.

◆ set_content_md5()

void azure::storage::cloud_file_properties::set_content_md5 ( utility::string_t value )

inline

Sets the content-MD5 value stored for the file.

Parameters

value The file's content-MD5 hash.

◆ set_content_type()

void azure::storage::cloud_file_properties::set_content_type ( utility::string_t content_type )

inline

Sets the content-type value stored for the file.

Parameters

value The file's content-type value.

◆ set_creation_time() [1/3]

void azure::storage::cloud_file_properties::set_creation_time ( utility::datetime value )

inline

Sets the creation time property for this file.

Parameters

value An ISO 8601 datetime utility::string_t.

◆ set_creation_time() [2/3]

void azure::storage::cloud_file_properties::set_creation_time ( now_t )

inline

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

Parameters

value Explicitly specified datetime value, must be azure::storage::cloud_file_properties::now.

◆ set_creation_time() [3/3]

void azure::storage::cloud_file_properties::set_creation_time ( preserve_t )

inline

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

Parameters

value Explicitly specified datetime value, must be azure::storage::cloud_file_properties::preserve.

◆ set_last_write_time() [1/3]

void azure::storage::cloud_file_properties::set_last_write_time ( utility::datetime value )

inline

Sets the last write time property for this file.

Parameters

value An ISO 8601 datetime utility::string_t.

◆ set_last_write_time() [2/3]

void azure::storage::cloud_file_properties::set_last_write_time ( now_t )

inline

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

Parameters

value Explicitly specified datetime value, must be azure::storage::cloud_file_properties::now.

◆ set_last_write_time() [3/3]

void azure::storage::cloud_file_properties::set_last_write_time ( preserve_t )

inline

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

Parameters

value Explicitly specified datetime value, must be azure::storage::cloud_file_properties::preserve.

◆ set_permission() [1/4]

void azure::storage::cloud_file_properties::set_permission ( utility::string_t value )

inline

Sets the permission property.

Parameters

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

◆ set_permission() [2/4]

void azure::storage::cloud_file_properties::set_permission ( inherit_t )

inline

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

Parameters

value Explicitly specified permission value, must be azure::storage::cloud_file_properties::inherit.

◆ set_permission() [3/4]

void azure::storage::cloud_file_properties::set_permission ( preserve_t )

inline

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

Parameters

value Explicitly specified permission value, must be azure::storage::cloud_file_properties::preserve.

◆ set_permission() [4/4]

void azure::storage::cloud_file_properties::set_permission ( source_t )

inline

Sets the permission property value to source, which means security descriptor shall be set for the target file by copying from the source file.

Parameters

value Explicitly specified permission value, must be azure::storage::cloud_file_properties::source.

This only applies to copy operation.

◆ set_permission_key()

void azure::storage::cloud_file_properties::set_permission_key ( utility::string_t value )

inline

Sets security descriptor of permission.

Parameters

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

◆ set_server_encrypted()

void azure::storage::cloud_file_properties::set_server_encrypted ( bool value )

inline

Sets if the server is encrypted.

Parameters

value If the server is encrypted.

◆ size()

utility::size64_t azure::storage::cloud_file_properties::size ( ) const

inline

Gets the size of the file, in bytes.

Returns: The file's size in bytes.

◆ type()

const utility::string_t& azure::storage::cloud_file_properties::type ( ) const

inline

Gets the type of the file.

Returns: An utility::string_t& object that indicates the type of the file.

Classes

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ cloud_file_properties()

Member Function Documentation

◆ attributes()

◆ cache_control()

◆ change_time()

◆ content_disposition()

◆ content_encoding()

◆ content_language()

◆ content_md5()

◆ content_type()

◆ creation_time()

◆ etag()

◆ file_id()

◆ file_parent_id()

◆ last_modified()

◆ last_write_time()

◆ lease_duration()

◆ lease_state()

◆ lease_status()

◆ length()

◆ permission()

◆ permission_key()

◆ server_encrypted()

◆ set_attributes()

◆ set_cache_control()

◆ set_content_disposition()

◆ set_content_encoding()

◆ set_content_language()

◆ set_content_md5()

◆ set_content_type()

◆ set_creation_time() [1/3]

◆ set_creation_time() [2/3]

◆ set_creation_time() [3/3]

◆ set_last_write_time() [1/3]

◆ set_last_write_time() [2/3]

◆ set_last_write_time() [3/3]

◆ set_permission() [1/4]

◆ set_permission() [2/4]

◆ set_permission() [3/4]

◆ set_permission() [4/4]

◆ set_permission_key()

◆ set_server_encrypted()

◆ size()

◆ type()