com.google.api.control.model

Enum KnownMetrics

java.lang.Object

java.lang.Enum<KnownMetrics>

com.google.api.control.model.KnownMetrics

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<KnownMetrics>

public enum KnownMetrics
extends java.lang.Enum<KnownMetrics>

KnownMetric enumerates the well-known metrics and allows them to be added to the ReportRequest.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSUMER_BACKEND_LATENCIES
CONSUMER_REQUEST_COUNT
CONSUMER_REQUEST_ERROR_COUNT
CONSUMER_REQUEST_OVERHEAD_LATENCIES
CONSUMER_REQUEST_SIZES
CONSUMER_RESPONSE_SIZES
CONSUMER_TOTAL_LATENCIES
PRODUCER_BACKEND_LATENCIES
PRODUCER_BY_CONSUMER_BACKEND_LATENCIES
PRODUCER_BY_CONSUMER_ERROR_COUNT
PRODUCER_BY_CONSUMER_REQUEST_COUNT
PRODUCER_BY_CONSUMER_REQUEST_OVERHEAD_LATENCIES
PRODUCER_BY_CONSUMER_REQUEST_SIZES
PRODUCER_BY_CONSUMER_RESPONSE_SIZES
PRODUCER_BY_CONSUMER_TOTAL_LATENCIES
PRODUCER_REQUEST_COUNT
PRODUCER_REQUEST_ERROR_COUNT
PRODUCER_REQUEST_OVERHEAD_LATENCIES
PRODUCER_REQUEST_SIZES
PRODUCER_RESPONSE_SIZES
PRODUCER_TOTAL_LATENCIES

Method Summary

Modifier and Type	Method and Description
com.google.api.MetricDescriptor.MetricKind	getKind()
java.lang.String	getName()
com.google.api.MetricDescriptor.ValueType	getType()
com.google.api.control.model.KnownMetrics.Update	getUpdater()
static boolean	isSupported(com.google.api.MetricDescriptor d) Determines if the given MetricDescriptor is supported.
boolean	matches(com.google.api.MetricDescriptor d) Determines if d matches this KnownMetric instance.
void	performUpdate(ReportRequestInfo info, com.google.api.servicecontrol.v1.Operation.Builder o) Adds metrics to an operation from the provided request data
static KnownMetrics	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KnownMetrics[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONSUMER_REQUEST_COUNT

public static final KnownMetrics CONSUMER_REQUEST_COUNT

PRODUCER_REQUEST_COUNT

public static final KnownMetrics PRODUCER_REQUEST_COUNT

PRODUCER_BY_CONSUMER_REQUEST_COUNT

public static final KnownMetrics PRODUCER_BY_CONSUMER_REQUEST_COUNT

CONSUMER_REQUEST_SIZES

public static final KnownMetrics CONSUMER_REQUEST_SIZES

PRODUCER_REQUEST_SIZES

public static final KnownMetrics PRODUCER_REQUEST_SIZES

PRODUCER_BY_CONSUMER_REQUEST_SIZES

public static final KnownMetrics PRODUCER_BY_CONSUMER_REQUEST_SIZES

CONSUMER_RESPONSE_SIZES

public static final KnownMetrics CONSUMER_RESPONSE_SIZES

PRODUCER_RESPONSE_SIZES

public static final KnownMetrics PRODUCER_RESPONSE_SIZES

PRODUCER_BY_CONSUMER_RESPONSE_SIZES

public static final KnownMetrics PRODUCER_BY_CONSUMER_RESPONSE_SIZES

CONSUMER_REQUEST_ERROR_COUNT

public static final KnownMetrics CONSUMER_REQUEST_ERROR_COUNT

PRODUCER_REQUEST_ERROR_COUNT

public static final KnownMetrics PRODUCER_REQUEST_ERROR_COUNT

PRODUCER_BY_CONSUMER_ERROR_COUNT

public static final KnownMetrics PRODUCER_BY_CONSUMER_ERROR_COUNT

CONSUMER_TOTAL_LATENCIES

public static final KnownMetrics CONSUMER_TOTAL_LATENCIES

PRODUCER_TOTAL_LATENCIES

public static final KnownMetrics PRODUCER_TOTAL_LATENCIES

PRODUCER_BY_CONSUMER_TOTAL_LATENCIES

public static final KnownMetrics PRODUCER_BY_CONSUMER_TOTAL_LATENCIES

CONSUMER_BACKEND_LATENCIES

public static final KnownMetrics CONSUMER_BACKEND_LATENCIES

PRODUCER_BACKEND_LATENCIES

public static final KnownMetrics PRODUCER_BACKEND_LATENCIES

PRODUCER_BY_CONSUMER_BACKEND_LATENCIES

public static final KnownMetrics PRODUCER_BY_CONSUMER_BACKEND_LATENCIES

CONSUMER_REQUEST_OVERHEAD_LATENCIES

public static final KnownMetrics CONSUMER_REQUEST_OVERHEAD_LATENCIES

PRODUCER_REQUEST_OVERHEAD_LATENCIES

public static final KnownMetrics PRODUCER_REQUEST_OVERHEAD_LATENCIES

PRODUCER_BY_CONSUMER_REQUEST_OVERHEAD_LATENCIES

public static final KnownMetrics PRODUCER_BY_CONSUMER_REQUEST_OVERHEAD_LATENCIES

Method Detail

values

public static KnownMetrics[] 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 (KnownMetrics c : KnownMetrics.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KnownMetrics valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getName

public java.lang.String getName()

Returns:

the name of metrics that match this instance

getKind

public com.google.api.MetricDescriptor.MetricKind getKind()

Returns:

the MetricKind of metrics that match this instance

getType

public com.google.api.MetricDescriptor.ValueType getType()

Returns:

the ValueType of metrics that match this instance

getUpdater

public com.google.api.control.model.KnownMetrics.Update getUpdater()

matches

public boolean matches(com.google.api.MetricDescriptor d)

Determines if d matches this KnownMetric instance.

Parameters:

d - a LabelDescriptor

Returns:

true if d matches

isSupported

public static boolean isSupported(com.google.api.MetricDescriptor d)

Determines if the given MetricDescriptor is supported.

Parameters:

d - a MetricDescriptor

Returns:

true if the MetricDescriptor is supported, otherwise false

performUpdate

public void performUpdate(ReportRequestInfo info,
                          com.google.api.servicecontrol.v1.Operation.Builder o)

Adds metrics to an operation from the provided request data

Parameters:

info - contains request data to be reported

o - the Operation.Builder to which metrics will be added