ConfigurationKey (Protocol Translator 0.14.0.Final API)

java.lang.Object
- java.lang.Enum<ConfigurationKey>
- - org.hawkular.metrics.clients.ptrans.ConfigurationKey

All Implemented Interfaces:

Serializable, Comparable<ConfigurationKey>
```
public enum ConfigurationKey
extends Enum<ConfigurationKey>
```
PTrans configuration keys.

Author:

Thomas Segismont

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTH_ID` Authentication id.
`AUTH_SECRET` Authentication secret.
`BATCH_SIZE` Size of the metric batches sent to the backend.
`BUFFER_CAPACITY` Capacity of the buffer where incoming metrics are queued before sending to the backend.
`COLLECTD_PORT` UDP port for collectd type of messages.
`GANGLIA_GROUP` Ganglia group.
`GANGLIA_MULTICAST_INTERFACE` Explicit multicast interface.
`GANGLIA_PORT` Ganglia port.
`GRAPHITE_PORT` TCP port for graphite type of messages.
`HTTP_PROXY` If present the HTTP proxy to use.
`PERSONA_ID` Hawkular Persona id.
`REST_MAX_CONNECTIONS` Maximum number of HTTP connections used to send metrics to the backend.
`REST_URL` REST endpoint.
`SERVER_TYPE` Server type.
`SERVICES` Services to start.
`STATSD_PORT` UDP port for statsd type of messages.
`TCP_PORT` Multiplexed TCP port.
`TENANT` Tenant.
`UDP_PORT` Multiplexed UDP port.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`toString()`
`static ConfigurationKey`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ConfigurationKey[]`	`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
  - SERVICES
```
public static final ConfigurationKey SERVICES
```
    Services to start.
  - UDP_PORT
```
public static final ConfigurationKey UDP_PORT
```
    Multiplexed UDP port.
  - TCP_PORT
```
public static final ConfigurationKey TCP_PORT
```
    Multiplexed TCP port.
  - GANGLIA_PORT
```
public static final ConfigurationKey GANGLIA_PORT
```
    Ganglia port.
  - GANGLIA_GROUP
```
public static final ConfigurationKey GANGLIA_GROUP
```
    Ganglia group.
  - GANGLIA_MULTICAST_INTERFACE
```
public static final ConfigurationKey GANGLIA_MULTICAST_INTERFACE
```
    Explicit multicast interface.
  - STATSD_PORT
```
public static final ConfigurationKey STATSD_PORT
```
    UDP port for statsd type of messages.
  - COLLECTD_PORT
```
public static final ConfigurationKey COLLECTD_PORT
```
    UDP port for collectd type of messages.
  - GRAPHITE_PORT
```
public static final ConfigurationKey GRAPHITE_PORT
```
    TCP port for graphite type of messages.
  - REST_URL
```
public static final ConfigurationKey REST_URL
```
    REST endpoint.
  - HTTP_PROXY
```
public static final ConfigurationKey HTTP_PROXY
```
    If present the HTTP proxy to use.
  - SERVER_TYPE
```
public static final ConfigurationKey SERVER_TYPE
```
    Server type.
  - TENANT
```
public static final ConfigurationKey TENANT
```
    Tenant. Used when server type is standalone Metrics.
  - AUTH_ID
```
public static final ConfigurationKey AUTH_ID
```
    Authentication id. Used when server type is Hawkular.
  - AUTH_SECRET
```
public static final ConfigurationKey AUTH_SECRET
```
    Authentication secret. Used when server type is Hawkular.
  - PERSONA_ID
```
public static final ConfigurationKey PERSONA_ID
```
    Hawkular Persona id. Used when server type is Hawkular.
  - BUFFER_CAPACITY
```
public static final ConfigurationKey BUFFER_CAPACITY
```
    Capacity of the buffer where incoming metrics are queued before sending to the backend.
  - BATCH_SIZE
```
public static final ConfigurationKey BATCH_SIZE
```
    Size of the metric batches sent to the backend.
  - REST_MAX_CONNECTIONS
```
public static final ConfigurationKey REST_MAX_CONNECTIONS
```
    Maximum number of HTTP connections used to send metrics to the backend.
- Method Detail
  - values
```
public static ConfigurationKey[] 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 (ConfigurationKey c : ConfigurationKey.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ConfigurationKey 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<ConfigurationKey>
    
    Returns:
    
    string representation of this configuration key

Enum ConfigurationKey

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SERVICES

UDP_PORT

TCP_PORT

GANGLIA_PORT

GANGLIA_GROUP

GANGLIA_MULTICAST_INTERFACE

STATSD_PORT

COLLECTD_PORT

GRAPHITE_PORT

REST_URL

HTTP_PROXY

SERVER_TYPE

TENANT

AUTH_ID

AUTH_SECRET

PERSONA_ID

BUFFER_CAPACITY

BATCH_SIZE

REST_MAX_CONNECTIONS

Method Detail

values

valueOf

toString