GangliaComponentBuilderFactory.GangliaComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.ganglia.GangliaComponent>

All Known Implementing Classes:

GangliaComponentBuilderFactory.GangliaComponentBuilderImpl

Enclosing interface:

GangliaComponentBuilderFactory
```
public static interface GangliaComponentBuilderFactory.GangliaComponentBuilder
extends ComponentBuilder<org.apache.camel.component.ganglia.GangliaComponent>
```
Builder for the Ganglia component.

Method Summary

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

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - dmax
```
default GangliaComponentBuilderFactory.GangliaComponentBuilder 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
  - groupName
```
default GangliaComponentBuilderFactory.GangliaComponentBuilder 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 GangliaComponentBuilderFactory.GangliaComponentBuilder 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
  - metricName
```
default GangliaComponentBuilderFactory.GangliaComponentBuilder 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 GangliaComponentBuilderFactory.GangliaComponentBuilder mode(info.ganglia.gmetric4j.gmetric.GMetric.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
  - prefix
```
default GangliaComponentBuilderFactory.GangliaComponentBuilder 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 GangliaComponentBuilderFactory.GangliaComponentBuilder slope(info.ganglia.gmetric4j.gmetric.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
  - spoofHostname
```
default GangliaComponentBuilderFactory.GangliaComponentBuilder 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 GangliaComponentBuilderFactory.GangliaComponentBuilder 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
  - ttl
```
default GangliaComponentBuilderFactory.GangliaComponentBuilder 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
  - type
```
default GangliaComponentBuilderFactory.GangliaComponentBuilder type(info.ganglia.gmetric4j.gmetric.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
  - units
```
default GangliaComponentBuilderFactory.GangliaComponentBuilder 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 GangliaComponentBuilderFactory.GangliaComponentBuilder 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
  - autowiredEnabled
```
default GangliaComponentBuilderFactory.GangliaComponentBuilder autowiredEnabled(boolean autowiredEnabled)
```
    Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
    
    Parameters:
    
    autowiredEnabled - the value to set
    
    Returns:
    
    the dsl builder
  - configuration
```
default GangliaComponentBuilderFactory.GangliaComponentBuilder configuration(org.apache.camel.component.ganglia.GangliaConfiguration configuration)
```
    To use the shared configuration. The option is a: <code>org.apache.camel.component.ganglia.GangliaConfiguration</code> type. Group: advanced
    
    Parameters:
    
    configuration - the value to set
    
    Returns:
    
    the dsl builder

Interface GangliaComponentBuilderFactory.GangliaComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

dmax

groupName

lazyStartProducer

metricName

mode

prefix

slope

spoofHostname

tmax

ttl

type

units

wireFormat31x

autowiredEnabled

configuration