MetricMXBean (IBM Streams Java Operator API)

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

```
public interface MetricMXBean
```
The management bean for a Metric.

Since:

InfoSphere® Streams Version 3.0

See Also:

OperatorContextMXBean.registerCustomMetric(String), OperatorContextMXBean.registerInputPortMetrics(int), OperatorContextMXBean.registerOutputPortMetrics(int), Metric

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class MetricMXBean.MetricType
Type of metrics represented by a MetricMXBean

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String METRIC_PROPERTY
Property key in the registered bean's object name that defines the type of the metric.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDescription()` Get the description of this metric.
`Metric.Kind`	`getKind()` Get the kind of this metric.
`java.lang.String`	`getName()` Get the name of this metric.
`long`	`getValue()` Get the value of this metric.

- Field Detail
  - METRIC_PROPERTY
```
static final java.lang.String METRIC_PROPERTY
```
    Property key in the registered bean's object name that defines the type of the metric. The value will correspond to a MetricMXBean.MetricType.type() return value.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
java.lang.String getName()
```
    Get the name of this metric.
    
    Returns:
    
    Name of the metric.
  - getDescription
```
java.lang.String getDescription()
```
    Get the description of this metric.
    
    Returns:
    
    Description of the metric.
  - getKind
```
Metric.Kind getKind()
```
    Get the kind of this metric.
    
    Returns:
    
    Kind of the metric.
  - getValue
```
long getValue()
```
    Get the value of this metric.
    
    Returns:
    
    Value of the metric.
    
    Throws:
    
    java.lang.IllegalStateException - Operator has been shutdown.