Metric (bullet-service 1.2.0 API)

java.lang.Object
- java.lang.Enum<Metric>
- - com.yahoo.bullet.rest.common.Metric

All Implemented Interfaces:

Serializable, Comparable<Metric>
```
public enum Metric
extends Enum<Metric>
```
This enum encapsulates the various metrics and statuses that various endpoints served by the API can have. The toHTTPStatus() returns the HTTP status code equivalent of each if isHTTPStatusCode(Metric) is true for it.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AVERAGE`
`BAD_REQUEST`
`COUNT`
`CREATED`
`ERROR`
`LATENCY`
`NO_CONTENT`
`NOT_FOUND`
`OK`
`TOO_MANY_REQUESTS`
`UNAVAILABLE`
`UNPROCESSABLE_ENTITY`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`isHTTPStatusCode(Metric metric)` Returns if the given metric corresponds to a HTTP status.
`org.springframework.http.HttpStatus`	`toHTTPStatus()` The `HttpStatus` equivalent of this enum, if one exists.
`String`	`toString()`
`static Metric`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Metric[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - OK
```
public static final Metric OK
```
  - CREATED
```
public static final Metric CREATED
```
  - NO_CONTENT
```
public static final Metric NO_CONTENT
```
  - BAD_REQUEST
```
public static final Metric BAD_REQUEST
```
  - NOT_FOUND
```
public static final Metric NOT_FOUND
```
  - UNPROCESSABLE_ENTITY
```
public static final Metric UNPROCESSABLE_ENTITY
```
  - TOO_MANY_REQUESTS
```
public static final Metric TOO_MANY_REQUESTS
```
  - ERROR
```
public static final Metric ERROR
```
  - UNAVAILABLE
```
public static final Metric UNAVAILABLE
```
  - COUNT
```
public static final Metric COUNT
```
  - AVERAGE
```
public static final Metric AVERAGE
```
  - LATENCY
```
public static final Metric LATENCY
```
- Method Detail
  - values
```
public static Metric[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Metric c : Metric.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Metric valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - toHTTPStatus
```
public org.springframework.http.HttpStatus toHTTPStatus()
```
    The HttpStatus equivalent of this enum, if one exists.
    
    Returns:
    
    The status code of the HTTP equivalent of this or null if none exists.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<Metric>
  - isHTTPStatusCode
```
public static boolean isHTTPStatusCode(Metric metric)
```
    Returns if the given metric corresponds to a HTTP status.
    
    Parameters:
    
    metric - The metric to check. Must be non-null.
    
    Returns:
    
    A boolean denoting if the metric is a HTTP status.

Enum Metric

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

OK

CREATED

NO_CONTENT

BAD_REQUEST

NOT_FOUND

UNPROCESSABLE_ENTITY

TOO_MANY_REQUESTS

ERROR

UNAVAILABLE

COUNT

AVERAGE

LATENCY

Method Detail

values

valueOf

toHTTPStatus

toString

isHTTPStatusCode