azure::storage::service_properties::metrics_properties Class Reference

An object representing the service properties pertaining to metrics. More...

Public Member Functions
	metrics_properties ()
	Initializes a new instance of the azure::storage::service_properties::metrics_properties class. More...
const utility::string_t &	version () const
	Gets the version of Storage Analytics in use. More...
void	set_version (utility::string_t value)
	Gets the version of Storage Analytics to use. More...
bool	enabled () const
	Gets a value indicating whether metrics is enabled for the storage service. More...
void	set_enabled (bool value)
	Sets a value indicating whether metrics is enabled for the storage service. More...
bool	include_apis () const
	Gets a value indicating whether metrics should generate summary statistics for called API operations. More...
void	set_include_apis (bool value)
	Sets a value indicating whether metrics should generate summary statistics for called API operations. More...
bool	retention_policy_enabled () const
	Gets a value indicating whether a retention policy is enabled for metrics. More...
void	set_retention_policy_enabled (bool value)
	Sets a value indicating whether a retention policy is enabled for metrics. More...
int	retention_days () const
	Gets the number of days that metrics data should be retained. More...
void	set_retention_days (int value)
	Sets the number of days that metrics data should be retained. More...

Detailed Description

An object representing the service properties pertaining to metrics.

Constructor & Destructor Documentation

metrics_properties()

azure::storage::service_properties::metrics_properties::metrics_properties ( )

inline

Initializes a new instance of the azure::storage::service_properties::metrics_properties class.

Member Function Documentation

enabled()

bool azure::storage::service_properties::metrics_properties::enabled ( ) const

inline

Gets a value indicating whether metrics is enabled for the storage service.

Returns

true if metrics is enabled for the storage service; otherwise, false.

include_apis()

bool azure::storage::service_properties::metrics_properties::include_apis ( ) const

inline

Gets a value indicating whether metrics should generate summary statistics for called API operations.

Returns

true if metrics should generate summary statistics for called API operations; otherwise, false.

retention_days()

int azure::storage::service_properties::metrics_properties::retention_days ( ) const

inline

Gets the number of days that metrics data should be retained.

Returns

The number of days to retain the metrics data. If this value is 0, the retention policy is disabled.

retention_policy_enabled()

bool azure::storage::service_properties::metrics_properties::retention_policy_enabled ( ) const

inline

Gets a value indicating whether a retention policy is enabled for metrics.

Returns

true if a retention policy is enabled; otherwise, false.

set_enabled()

void azure::storage::service_properties::metrics_properties::set_enabled ( bool  value )

inline

Sets a value indicating whether metrics is enabled for the storage service.

Parameters

value

Use true to enable metrics for the storage service; otherwise, false.

set_include_apis()

void azure::storage::service_properties::metrics_properties::set_include_apis ( bool  value )

inline

Sets a value indicating whether metrics should generate summary statistics for called API operations.

Parameters

value

Use true if metrics should generate summary statistics for called API operations; otherwise, false.

set_retention_days()

void azure::storage::service_properties::metrics_properties::set_retention_days ( int  value )

inline

Sets the number of days that metrics data should be retained.

Parameters

value

The number of days to retain the metrics data, or 0 to disable the retention policy.

set_retention_policy_enabled()

void azure::storage::service_properties::metrics_properties::set_retention_policy_enabled ( bool  value )

inline

Sets a value indicating whether a retention policy is enabled for metrics.

Parameters

value

Use true to enable retention policy; otherwise, false.

set_version()

void azure::storage::service_properties::metrics_properties::set_version ( utility::string_t  value )

inline

Gets the version of Storage Analytics to use.

Parameters

value

A string specifying the version of Storage Analytics to use. Set this value to "1.0".

version()

const utility::string_t& azure::storage::service_properties::metrics_properties::version ( ) const

inline

Gets the version of Storage Analytics in use.

Returns

A string specifying the version of Storage Analytics to use. Set this value to "1.0".