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::entity_property Class Reference

Class for storing information about a single property in an entity in a table. More...

Public Member Functions

 entity_property ()
 Initializes a new instance of the azure::storage::entity_property class. More...
 
 entity_property (const std::vector< uint8_t > &value)
 Initializes a new instance of the azure::storage::entity_property class with a byte array value. More...
 
 entity_property (bool value)
 Initializes a new instance of the azure::storage::entity_property class with a boolean value. More...
 
 entity_property (utility::datetime value)
 Initializes a new instance of the azure::storage::entity_property class with a date/time value. More...
 
 entity_property (double value)
 Initializes a new instance of the azure::storage::entity_property class with a double precision floating-point number value. More...
 
 entity_property (const utility::uuid &value)
 Initializes a new instance of the azure::storage::entity_property class with a GUID value. More...
 
 entity_property (int32_t value)
 Initializes a new instance of the azure::storage::entity_property class with a 32-bit integer value. More...
 
 entity_property (int64_t value)
 Initializes a new instance of the azure::storage::entity_property class with a 64-bit integer value. More...
 
 entity_property (utility::string_t value)
 Initializes a new instance of the azure::storage::entity_property class with a string value. More...
 
 entity_property (const utility::char_t *value)
 Initializes a new instance of the azure::storage::entity_property class with a string value. More...
 
azure::storage::edm_type property_type () const
 Gets the property type of the azure::storage::entity_property object. More...
 
void set_property_type (azure::storage::edm_type property_type)
 Sets the property type of the azure::storage::entity_property object. More...
 
bool is_null () const
 Indicates whether the value is null. More...
 
void set_is_null (bool value)
 Sets the value to null. More...
 
WASTORAGE_API std::vector< uint8_t > binary_value () const
 Gets the byte array value of the azure::storage::entity_property object. More...
 
WASTORAGE_API bool boolean_value () const
 Gets the boolean value of the azure::storage::entity_property object. More...
 
WASTORAGE_API utility::datetime datetime_value () const
 Gets the datetime value of the azure::storage::entity_property object. More...
 
WASTORAGE_API double double_value () const
 Gets the double-precision floating point value of the azure::storage::entity_property object. More...
 
WASTORAGE_API utility::uuid guid_value () const
 Gets the GUID value of the azure::storage::entity_property object. More...
 
WASTORAGE_API int32_t int32_value () const
 Gets the 32-bit integer value of the azure::storage::entity_property object. More...
 
WASTORAGE_API int64_t int64_value () const
 Gets the 64-bit integer value of the azure::storage::entity_property object. More...
 
WASTORAGE_API utility::string_t string_value () const
 Gets the string value of the azure::storage::entity_property object. More...
 
void set_value (const std::vector< uint8_t > &value)
 Sets the byte array value of the azure::storage::entity_property object. More...
 
void set_value (bool value)
 Sets the boolean value of the azure::storage::entity_property object. More...
 
void set_value (utility::datetime value)
 Sets the datetime value of the azure::storage::entity_property object. More...
 
void set_value (double value)
 Sets the double-precision floating point value of the azure::storage::entity_property object. More...
 
void set_value (const utility::uuid &value)
 Sets the GUID value of the azure::storage::entity_property object. More...
 
void set_value (int32_t value)
 Sets the 32-bit integer value of the azure::storage::entity_property object. More...
 
void set_value (int64_t value)
 Sets the 64-bit integer value of the azure::storage::entity_property object. More...
 
void set_value (utility::string_t value)
 Sets the string value of the azure::storage::entity_property object. More...
 
void set_value (const utility::char_t *value)
 Sets the string value of the azure::storage::entity_property object. More...
 
const utility::string_t & str () const
 Returns the value of the azure::storage::entity_property object as a string. More...
 

Detailed Description

Class for storing information about a single property in an entity in a table.

Constructor & Destructor Documentation

◆ entity_property() [1/10]

azure::storage::entity_property::entity_property ( )
inline

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

◆ entity_property() [2/10]

azure::storage::entity_property::entity_property ( const std::vector< uint8_t > &  value)
inline

Initializes a new instance of the azure::storage::entity_property class with a byte array value.

Parameters
valueA byte array.

◆ entity_property() [3/10]

azure::storage::entity_property::entity_property ( bool  value)
inline

Initializes a new instance of the azure::storage::entity_property class with a boolean value.

Parameters
valueA boolean value.

◆ entity_property() [4/10]

azure::storage::entity_property::entity_property ( utility::datetime  value)
inline

Initializes a new instance of the azure::storage::entity_property class with a date/time value.

Parameters
valueA datetime value.

◆ entity_property() [5/10]

azure::storage::entity_property::entity_property ( double  value)
inline

Initializes a new instance of the azure::storage::entity_property class with a double precision floating-point number value.

Parameters
valueA double value.

◆ entity_property() [6/10]

azure::storage::entity_property::entity_property ( const utility::uuid &  value)
inline

Initializes a new instance of the azure::storage::entity_property class with a GUID value.

Parameters
valueA GUID value.

◆ entity_property() [7/10]

azure::storage::entity_property::entity_property ( int32_t  value)
inline

Initializes a new instance of the azure::storage::entity_property class with a 32-bit integer value.

Parameters
valueA 32-bit integer value.

◆ entity_property() [8/10]

azure::storage::entity_property::entity_property ( int64_t  value)
inline

Initializes a new instance of the azure::storage::entity_property class with a 64-bit integer value.

Parameters
valueA 64-bit integer value.

◆ entity_property() [9/10]

azure::storage::entity_property::entity_property ( utility::string_t  value)
inline

Initializes a new instance of the azure::storage::entity_property class with a string value.

Parameters
valueA string value.

◆ entity_property() [10/10]

azure::storage::entity_property::entity_property ( const utility::char_t *  value)
inline

Initializes a new instance of the azure::storage::entity_property class with a string value.

Parameters
valueA string value.

Member Function Documentation

◆ binary_value()

WASTORAGE_API std::vector<uint8_t> azure::storage::entity_property::binary_value ( ) const

Gets the byte array value of the azure::storage::entity_property object.

Returns
The byte array value of the azure::storage::entity_property object.

An exception is thrown if this property is set to a value other than a byte array.

◆ boolean_value()

WASTORAGE_API bool azure::storage::entity_property::boolean_value ( ) const

Gets the boolean value of the azure::storage::entity_property object.

Returns
The boolean value of the azure::storage::entity_property object.

An exception is thrown if this property is set to a value other than a boolean value.

◆ datetime_value()

WASTORAGE_API utility::datetime azure::storage::entity_property::datetime_value ( ) const

Gets the datetime value of the azure::storage::entity_property object.

Returns
The datetime value of the azure::storage::entity_property object.

An exception is thrown if this property is set to a value other than a datetime value.

◆ double_value()

WASTORAGE_API double azure::storage::entity_property::double_value ( ) const

Gets the double-precision floating point value of the azure::storage::entity_property object.

Returns
The double-precision floating point value of the azure::storage::entity_property object.

An exception is thrown if this property is set to a value other than a double-precision floating point value.

◆ guid_value()

WASTORAGE_API utility::uuid azure::storage::entity_property::guid_value ( ) const

Gets the GUID value of the azure::storage::entity_property object.

Returns
The GUID value of the azure::storage::entity_property object.

An exception is thrown if this property is set to a value other than a GUID value.

◆ int32_value()

WASTORAGE_API int32_t azure::storage::entity_property::int32_value ( ) const

Gets the 32-bit integer value of the azure::storage::entity_property object.

Returns
The 32-bit integer value of the azure::storage::entity_property object.

An exception is thrown if this property is set to a value other than a 32-bit integer value.

◆ int64_value()

WASTORAGE_API int64_t azure::storage::entity_property::int64_value ( ) const

Gets the 64-bit integer value of the azure::storage::entity_property object.

Returns
The 64-bit integer value of the azure::storage::entity_property object.

An exception is thrown if this property is set to a value other than a 64-bit integer value.

◆ is_null()

bool azure::storage::entity_property::is_null ( ) const
inline

Indicates whether the value is null.

Returns
true if the value is null.

◆ property_type()

azure::storage::edm_type azure::storage::entity_property::property_type ( ) const
inline

Gets the property type of the azure::storage::entity_property object.

Returns
An azure::storage::edm_type object.

◆ set_is_null()

void azure::storage::entity_property::set_is_null ( bool  value)
inline

Sets the value to null.

Parameters
valuetrue to set the value to null.

◆ set_property_type()

void azure::storage::entity_property::set_property_type ( azure::storage::edm_type  property_type)
inline

Sets the property type of the azure::storage::entity_property object.

Parameters
property_typeAn azure::storage::edm_type object indicating the property type.

◆ set_value() [1/9]

void azure::storage::entity_property::set_value ( const std::vector< uint8_t > &  value)
inline

Sets the byte array value of the azure::storage::entity_property object.

Parameters
valueThe byte array value.

◆ set_value() [2/9]

void azure::storage::entity_property::set_value ( bool  value)
inline

Sets the boolean value of the azure::storage::entity_property object.

Parameters
valueThe boolean value.

◆ set_value() [3/9]

void azure::storage::entity_property::set_value ( utility::datetime  value)
inline

Sets the datetime value of the azure::storage::entity_property object.

Parameters
valueThe datetime value.

◆ set_value() [4/9]

void azure::storage::entity_property::set_value ( double  value)
inline

Sets the double-precision floating point value of the azure::storage::entity_property object.

Parameters
valueThe double-precision floating point value.

◆ set_value() [5/9]

void azure::storage::entity_property::set_value ( const utility::uuid &  value)
inline

Sets the GUID value of the azure::storage::entity_property object.

Parameters
valueThe GUID point value.

◆ set_value() [6/9]

void azure::storage::entity_property::set_value ( int32_t  value)
inline

Sets the 32-bit integer value of the azure::storage::entity_property object.

Parameters
valueThe 32-bit integer value.

◆ set_value() [7/9]

void azure::storage::entity_property::set_value ( int64_t  value)
inline

Sets the 64-bit integer value of the azure::storage::entity_property object.

Parameters
valueThe 64-bit integer value.

◆ set_value() [8/9]

void azure::storage::entity_property::set_value ( utility::string_t  value)
inline

Sets the string value of the azure::storage::entity_property object.

Parameters
valueThe string value.

◆ set_value() [9/9]

void azure::storage::entity_property::set_value ( const utility::char_t *  value)
inline

Sets the string value of the azure::storage::entity_property object.

Parameters
valueThe string value.

◆ str()

const utility::string_t& azure::storage::entity_property::str ( ) const
inline

Returns the value of the azure::storage::entity_property object as a string.

Returns
A string containing the property value.

◆ string_value()

WASTORAGE_API utility::string_t azure::storage::entity_property::string_value ( ) const

Gets the string value of the azure::storage::entity_property object.

Returns
The string value of the azure::storage::entity_property object.

An exception is thrown if this property is set to a value other than a string value.