GangliaEndpointBuilderFactory.GangliaEndpointBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

GangliaEndpointBuilderFactory
```
public static interface GangliaEndpointBuilderFactory.GangliaEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Builder for endpoint for the Ganglia component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`dmax(int dmax)` Minumum time in seconds before Ganglia will purge the metric value if it expires.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`dmax(String dmax)` Minumum time in seconds before Ganglia will purge the metric value if it expires.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`groupName(String groupName)` The group that the metric belongs to.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`lazyStartProducer(String lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`metricName(String metricName)` The name to use for the metric.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`mode(GangliaEndpointBuilderFactory.UDPAddressingMode mode)` Send the UDP metric packets using MULTICAST or UNICAST.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`mode(String mode)` Send the UDP metric packets using MULTICAST or UNICAST.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`prefix(String prefix)` Prefix the metric name with this string and an underscore.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`slope(GangliaEndpointBuilderFactory.GMetricSlope slope)` The slope.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`slope(String slope)` The slope.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`spoofHostname(String spoofHostname)` Spoofing information IP:hostname.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`tmax(int tmax)` Maximum time in seconds that the value can be considered current.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`tmax(String tmax)` Maximum time in seconds that the value can be considered current.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`ttl(int ttl)` If using multicast, set the TTL of the packets.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`ttl(String ttl)` If using multicast, set the TTL of the packets.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`type(GangliaEndpointBuilderFactory.GMetricType type)` The type of value.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`type(String type)` The type of value.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`units(String units)` Any unit of measurement that qualifies the metric, e.g.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`wireFormat31x(boolean wireFormat31x)` Use the wire format of Ganglia 3.1.0 and later versions.
`default GangliaEndpointBuilderFactory.GangliaEndpointBuilder`	`wireFormat31x(String wireFormat31x)` Use the wire format of Ganglia 3.1.0 and later versions.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve

- Method Detail
  - dmax
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder dmax(int dmax)
```
    Minumum time in seconds before Ganglia will purge the metric value if it expires. Set to 0 and the value will remain in Ganglia indefinitely until a gmond agent restart. The option is a: <code>int</code> type. Default: 0 Group: producer
    
    Parameters:
    
    dmax - the value to set
    
    Returns:
    
    the dsl builder
  - dmax
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder dmax(String dmax)
```
    Minumum time in seconds before Ganglia will purge the metric value if it expires. Set to 0 and the value will remain in Ganglia indefinitely until a gmond agent restart. The option will be converted to a <code>int</code> type. Default: 0 Group: producer
    
    Parameters:
    
    dmax - the value to set
    
    Returns:
    
    the dsl builder
  - groupName
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder groupName(String groupName)
```
    The group that the metric belongs to. The option is a: <code>java.lang.String</code> type. Default: java Group: producer
    
    Parameters:
    
    groupName - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder lazyStartProducer(boolean lazyStartProducer)
```
    Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder lazyStartProducer(String lazyStartProducer)
```
    Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - metricName
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder metricName(String metricName)
```
    The name to use for the metric. The option is a: <code>java.lang.String</code> type. Default: metric Group: producer
    
    Parameters:
    
    metricName - the value to set
    
    Returns:
    
    the dsl builder
  - mode
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder mode(GangliaEndpointBuilderFactory.UDPAddressingMode mode)
```
    Send the UDP metric packets using MULTICAST or UNICAST. The option is a: <code>info.ganglia.gmetric4j.gmetric.GMetric$UDPAddressingMode</code> type. Default: MULTICAST Group: producer
    
    Parameters:
    
    mode - the value to set
    
    Returns:
    
    the dsl builder
  - mode
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder mode(String mode)
```
    Send the UDP metric packets using MULTICAST or UNICAST. The option will be converted to a <code>info.ganglia.gmetric4j.gmetric.GMetric$UDPAddressingMode</code> type. Default: MULTICAST Group: producer
    
    Parameters:
    
    mode - the value to set
    
    Returns:
    
    the dsl builder
  - prefix
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder prefix(String prefix)
```
    Prefix the metric name with this string and an underscore. The option is a: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    prefix - the value to set
    
    Returns:
    
    the dsl builder
  - slope
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder slope(GangliaEndpointBuilderFactory.GMetricSlope slope)
```
    The slope. The option is a: <code>info.ganglia.gmetric4j.gmetric.GMetricSlope</code> type. Default: BOTH Group: producer
    
    Parameters:
    
    slope - the value to set
    
    Returns:
    
    the dsl builder
  - slope
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder slope(String slope)
```
    The slope. The option will be converted to a <code>info.ganglia.gmetric4j.gmetric.GMetricSlope</code> type. Default: BOTH Group: producer
    
    Parameters:
    
    slope - the value to set
    
    Returns:
    
    the dsl builder
  - spoofHostname
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder spoofHostname(String spoofHostname)
```
    Spoofing information IP:hostname. The option is a: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    spoofHostname - the value to set
    
    Returns:
    
    the dsl builder
  - tmax
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder tmax(int tmax)
```
    Maximum time in seconds that the value can be considered current. After this, Ganglia considers the value to have expired. The option is a: <code>int</code> type. Default: 60 Group: producer
    
    Parameters:
    
    tmax - the value to set
    
    Returns:
    
    the dsl builder
  - tmax
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder tmax(String tmax)
```
    Maximum time in seconds that the value can be considered current. After this, Ganglia considers the value to have expired. The option will be converted to a <code>int</code> type. Default: 60 Group: producer
    
    Parameters:
    
    tmax - the value to set
    
    Returns:
    
    the dsl builder
  - ttl
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder ttl(int ttl)
```
    If using multicast, set the TTL of the packets. The option is a: <code>int</code> type. Default: 5 Group: producer
    
    Parameters:
    
    ttl - the value to set
    
    Returns:
    
    the dsl builder
  - ttl
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder ttl(String ttl)
```
    If using multicast, set the TTL of the packets. The option will be converted to a <code>int</code> type. Default: 5 Group: producer
    
    Parameters:
    
    ttl - the value to set
    
    Returns:
    
    the dsl builder
  - type
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder type(GangliaEndpointBuilderFactory.GMetricType type)
```
    The type of value. The option is a: <code>info.ganglia.gmetric4j.gmetric.GMetricType</code> type. Default: STRING Group: producer
    
    Parameters:
    
    type - the value to set
    
    Returns:
    
    the dsl builder
  - type
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder type(String type)
```
    The type of value. The option will be converted to a <code>info.ganglia.gmetric4j.gmetric.GMetricType</code> type. Default: STRING Group: producer
    
    Parameters:
    
    type - the value to set
    
    Returns:
    
    the dsl builder
  - units
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder units(String units)
```
    Any unit of measurement that qualifies the metric, e.g. widgets, litres, bytes. Do not include a prefix such as k (kilo) or m (milli), other tools may scale the units later. The value should be unscaled. The option is a: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    units - the value to set
    
    Returns:
    
    the dsl builder
  - wireFormat31x
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder wireFormat31x(boolean wireFormat31x)
```
    Use the wire format of Ganglia 3.1.0 and later versions. Set this to false to use Ganglia 3.0.x or earlier. The option is a: <code>boolean</code> type. Default: true Group: producer
    
    Parameters:
    
    wireFormat31x - the value to set
    
    Returns:
    
    the dsl builder
  - wireFormat31x
```
default GangliaEndpointBuilderFactory.GangliaEndpointBuilder wireFormat31x(String wireFormat31x)
```
    Use the wire format of Ganglia 3.1.0 and later versions. Set this to false to use Ganglia 3.0.x or earlier. The option will be converted to a <code>boolean</code> type. Default: true Group: producer
    
    Parameters:
    
    wireFormat31x - the value to set
    
    Returns:
    
    the dsl builder

Interface GangliaEndpointBuilderFactory.GangliaEndpointBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

dmax

dmax

groupName

lazyStartProducer

lazyStartProducer

metricName

mode

mode

prefix

slope

slope

spoofHostname

tmax

tmax

ttl

ttl

type

type

units

wireFormat31x

wireFormat31x