Org.Apache.REEF.Common.Metrics.Api.MetricsTag Class Reference

Metrics tag class. More...

Public Member Functions
override string	ToString ()
	String representation of a tag for display. More...
override bool	Equals (object obj)
	Checks whether two tags are equal. More...
override int	GetHashCode ()
	Return hash code of the Tag object. More...

Properties
string	Name [get]
	Name of the tag. More...
string	Description [get]
	Description of the tag. More...
IMetricsInfo	Info [get]
	Info object of the tag. More...
string	Value [get]
	Value of the tag. More...

Detailed Description

Metrics tag class.

Tags can be used to group records together at source, sink or other appropriate places. They can also be used in MetricsFilter to filter records at higher level.

Member Function Documentation

Equals()

override bool Org.Apache.REEF.Common.Metrics.Api.MetricsTag.Equals ( object  obj )

inline

Checks whether two tags are equal.

Relies on Equals function of IMetricsInfo implementations.

Parameters

obj	Object to compare against.

Returns

True if both represent the same tag.

GetHashCode()

override int Org.Apache.REEF.Common.Metrics.Api.MetricsTag.GetHashCode ( )

inline

Return hash code of the Tag object.

Simply uses the hash of ToString() method.

Returns

Hash code.

ToString()

override string Org.Apache.REEF.Common.Metrics.Api.MetricsTag.ToString ( )

inline

String representation of a tag for display.

Returns

The string representation of the tag.

Property Documentation

Description

string Org.Apache.REEF.Common.Metrics.Api.MetricsTag.Description

get

Description of the tag.

Info

IMetricsInfo Org.Apache.REEF.Common.Metrics.Api.MetricsTag.Info

get

Info object of the tag.

Name

string Org.Apache.REEF.Common.Metrics.Api.MetricsTag.Name

get

Name of the tag.

Value

string Org.Apache.REEF.Common.Metrics.Api.MetricsTag.Value

get

Value of the tag.

---

The documentation for this class was generated from the following file:

• lang/cs/Org.Apache.REEF.Common/metrics/Api/MetricsTag.cs