VMware GemFire Native .NET Reference  9.2.4
Apache::Geode::Client::StatisticsType Class Reference

This class is used to describe a logical collection of StatisticDescriptors.These descriptions are used to create an instance of Statistics class. More...

Inherits UMWrap< apache::geode::statistics::StatisticsType >.

Public Member Functions

virtual StatisticDescriptorNameToDescriptor (String^ name)
 Returns the descriptor of the statistic with the given name in this statistics instance. More...
 
virtual System::Int32 NameToId (String^ name)
 Returns the id of the statistic with the given name in this statistics instance. More...
 

Properties

virtual String^ Description [get]
 Returns a description of this statistics type. More...
 
virtual System::Int32 DescriptorsCount [get]
 Returns the total number of statistics descriptors in the type. More...
 
virtual String^ Name [get]
 Returns the name of this statistics type. More...
 
virtual array< StatisticDescriptor^>^ Statistics [get]
 Returns descriptions of the statistics that this statistics type gathers together. More...
 

Detailed Description

This class is used to describe a logical collection of StatisticDescriptors.These descriptions are used to create an instance of Statistics class.

To get an instance of this interface use an instance of StatisticsFactory class.

The class is purposefully inherited from UMWrapN and not UMWrap as the destructor of the class is protected, and so it is now not called from inside the InternalCleanup method.

Member Function Documentation

◆ NameToDescriptor()

virtual StatisticDescriptor ^ Apache::Geode::Client::StatisticsType::NameToDescriptor ( String^  name)
virtual

Returns the descriptor of the statistic with the given name in this statistics instance.

Parameters
namethe statistic name
Returns
the descriptor of the statistic with the given name
Exceptions
IllegalArgumentExceptionif no statistic named name exists in this statistic instance.

◆ NameToId()

virtual System::Int32 Apache::Geode::Client::StatisticsType::NameToId ( String^  name)
virtual

Returns the id of the statistic with the given name in this statistics instance.

Parameters
namethe statistic name
Returns
the id of the statistic with the given name
Exceptions
IllegalArgumentExceptionif no statistic named name exists in this statistic instance.

Property Documentation

◆ Description

virtual String^ Apache::Geode::Client::StatisticsType::Description
get

Returns a description of this statistics type.

◆ DescriptorsCount

virtual System:: Int32 Apache::Geode::Client::StatisticsType::DescriptorsCount
get

Returns the total number of statistics descriptors in the type.

◆ Name

virtual String^ Apache::Geode::Client::StatisticsType::Name
get

Returns the name of this statistics type.

◆ Statistics

virtual array< StatisticDescriptor^>^ Apache::Geode::Client::StatisticsType::Statistics
get

Returns descriptions of the statistics that this statistics type gathers together.


VMware GemFire .NET Cache API Documentation