azure::storage::file_access_condition Class Reference

Represents a set of access conditions to be used for operations against the File service. Reserved for future support of file conditional headers. More...

Public Member Functions
	file_access_condition ()
	Constructs an empty file access condition. More...
bool	is_valid () const
	Returns if this condition is empty. 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...

Static Public Member Functions
static file_access_condition	generate_lease_condition (utility::string_t lease_id)
	Generates a file access condition such that an operation will be performed only if the lease ID on the resource matches the specified lease ID. More...

Detailed Description

Represents a set of access conditions to be used for operations against the File service. Reserved for future support of file conditional headers.

Constructor & Destructor Documentation

file_access_condition()

azure::storage::file_access_condition::file_access_condition ( )

inline

Constructs an empty file access condition.

Member Function Documentation

generate_lease_condition()

static file_access_condition azure::storage::file_access_condition::generate_lease_condition ( utility::string_t  lease_id )

inlinestatic

Generates a file access condition such that an operation will be performed only if the lease ID on the resource matches the specified lease ID.

Parameters

lease_id

The lease ID that must match the lease ID of the resource.

Returns

An azure::storage::file_access_condition object that represents the lease condition.

is_valid()

bool azure::storage::file_access_condition::is_valid ( ) const

inline

Returns if this condition is empty.

Returns

true if this condition is empty, false otherwise.

lease_id()

const utility::string_t& azure::storage::file_access_condition::lease_id ( ) const

inline

Gets a lease ID that must match the lease on a resource.

Returns

A string containing the lease ID.

set_lease_id()

void azure::storage::file_access_condition::set_lease_id ( utility::string_t  value )

inline

Sets a lease ID that must match the lease on a resource.

Parameters

value

A string containing the lease ID.