org.apache.camel.model

Class SamplingDefinition

java.lang.Object

org.apache.camel.model.OptionalIdentifiedDefinition<Type>

org.apache.camel.model.ProcessorDefinition<Type>

org.apache.camel.model.NoOutputDefinition<SamplingDefinition>

org.apache.camel.model.SamplingDefinition

All Implemented Interfaces:

Block, org.apache.camel.NamedNode

@Metadata(label="eip,routing")
public class SamplingDefinition
extends NoOutputDefinition<SamplingDefinition>

Extract a sample of the messages passing through a route

Field Summary

Fields inherited from class org.apache.camel.model.ProcessorDefinition

inheritErrorHandler, log

Constructor Summary

Constructors

Constructor and Description
SamplingDefinition()
SamplingDefinition(Duration period)
SamplingDefinition(long messageFrequency)
SamplingDefinition(long samplePeriod, TimeUnit units)

Method Summary

Modifier and Type	Method and Description
protected String	description()
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
String	getMessageFrequency()
String	getSamplePeriod()
String	getShortName()
String	getUnits() Deprecated.
SamplingDefinition	sampleMessageFrequency(long messageFrequency) Sets the sample message count which only a single Exchange will pass through after this many received.
SamplingDefinition	samplePeriod(Duration samplePeriod) Sets the sample period during which only a single Exchange will pass through.
SamplingDefinition	samplePeriod(long samplePeriod) Sets the sample period during which only a single Exchange will pass through.
void	setMessageFrequency(long messageFrequency)
void	setMessageFrequency(String messageFrequency) Sets the sample message count which only a single Exchange will pass through after this many received.
void	setSamplePeriod(Duration samplePeriod)
void	setSamplePeriod(long samplePeriod)
void	setSamplePeriod(String samplePeriod) Sets the sample period during which only a single Exchange will pass through.
void	setUnits(String units) Deprecated.
void	setUnits(TimeUnit units) Deprecated.
SamplingDefinition	timeUnits(TimeUnit units) Deprecated.
String	toString()

Methods inherited from class org.apache.camel.model.NoOutputDefinition

getOutputs

Methods inherited from class org.apache.camel.model.ProcessorDefinition

addInterceptStrategy, addOutput, aggregate, aggregate, aggregate, aggregate, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, choice, circuitBreaker, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, configureChild, convertBodyTo, convertBodyTo, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, endChoice, endCircuitBreaker, endDoTry, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getParent, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, onException, pipeline, pipeline, pipeline, pipeline, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, preCreateProcessor, process, process, process, recipientList, recipientList, recipientList, recipientList, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, sort, sort, sort, split, split, split, startupOrder, step, step, stop, threads, threads, threads, threads, throttle, throttle, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, to, to, to, to, toD, toD, toD, toD, toD, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition

description, description, getCustomId, getDescription, getDescriptionText, getId, hasCustomIdAssigned, idOrCreate, setCustomId, setDescription, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SamplingDefinition

public SamplingDefinition()

SamplingDefinition

public SamplingDefinition(Duration period)

SamplingDefinition

public SamplingDefinition(long samplePeriod,
                          TimeUnit units)

SamplingDefinition

public SamplingDefinition(long messageFrequency)

Method Detail

getShortName

public String getShortName()

toString

public String toString()

Overrides:

toString in class Object

description

protected String description()

getLabel

public String getLabel()

Description copied from class: ProcessorDefinition

Returns a label to describe this node such as the expression if some kind of expression node

Specified by:

getLabel in interface org.apache.camel.NamedNode

Overrides:

getLabel in class ProcessorDefinition<SamplingDefinition>

sampleMessageFrequency

public SamplingDefinition sampleMessageFrequency(long messageFrequency)

Sets the sample message count which only a single Exchange will pass through after this many received.

Parameters:

messageFrequency -

Returns:

the builder

samplePeriod

public SamplingDefinition samplePeriod(Duration samplePeriod)

Sets the sample period during which only a single Exchange will pass through.

Parameters:

samplePeriod - the period

Returns:

the builder

samplePeriod

public SamplingDefinition samplePeriod(long samplePeriod)

Sets the sample period during which only a single Exchange will pass through.

Parameters:

samplePeriod - the period

Returns:

the builder

timeUnits

@Deprecated
public SamplingDefinition timeUnits(TimeUnit units)

Deprecated.

Sets the time units for the sample period, defaulting to seconds.

Parameters:

units - the time unit of the sample period.

Returns:

the builder

getSamplePeriod

public String getSamplePeriod()

setSamplePeriod

public void setSamplePeriod(String samplePeriod)

Sets the sample period during which only a single Exchange will pass through.

setSamplePeriod

public void setSamplePeriod(long samplePeriod)

setSamplePeriod

public void setSamplePeriod(Duration samplePeriod)

getMessageFrequency

public String getMessageFrequency()

setMessageFrequency

public void setMessageFrequency(String messageFrequency)

Sets the sample message count which only a single Exchange will pass through after this many received.

setMessageFrequency

public void setMessageFrequency(long messageFrequency)

setUnits

@Deprecated
public void setUnits(String units)

Deprecated.

Sets the time units for the sample period, defaulting to seconds.

setUnits

@Deprecated
public void setUnits(TimeUnit units)

Deprecated.

Sets the time units for the sample period, defaulting to seconds.

getUnits

@Deprecated
public String getUnits()

Deprecated.