Package 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:
org.apache.camel.CamelContextAware
,org.apache.camel.LineNumberAware
,Block
,org.apache.camel.NamedNode
,org.apache.camel.spi.HasId
,org.apache.camel.spi.IdAware
@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
disabled, inheritErrorHandler
-
-
Constructor Summary
Constructors Constructor Description SamplingDefinition()
SamplingDefinition(long messageFrequency)
SamplingDefinition(long samplePeriod, TimeUnit units)
SamplingDefinition(String samplePeriod)
SamplingDefinition(Duration period)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected String
description()
String
getLabel()
Returns a label to describe this node such as the expression if some kind of expression nodeString
getMessageFrequency()
String
getSamplePeriod()
String
getShortName()
SamplingDefinition
sampleMessageFrequency(long messageFrequency)
Sets the sample message count which only a singleExchange
will pass through after this many received.SamplingDefinition
samplePeriod(long samplePeriod)
Sets the sample period during which only a singleExchange
will pass through.SamplingDefinition
samplePeriod(String samplePeriod)
Sets the sample period during which only a singleExchange
will pass through.SamplingDefinition
samplePeriod(Duration samplePeriod)
Sets the sample period during which only a singleExchange
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(long samplePeriod)
void
setSamplePeriod(String samplePeriod)
Sets the sample period during which only a single Exchange will pass through.void
setSamplePeriod(Duration samplePeriod)
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, convertBodyTo, delay, delay, delay, disabled, disabled, disabled, doTry, dynamicRouter, dynamicRouter, end, endChoice, endCircuitBreaker, endDoCatch, endDoTry, endParent, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getDisabled, getIndex, getInterceptStrategies, getParent, getRouteConfiguration, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, kamelet, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, nodePrefixId, onCompletion, onException, onException, pausable, pausable, pausable, pausable, 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, resumable, resumable, resumable, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setDisabled, setExchangePattern, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, setRouteConfiguration, sort, sort, sort, split, 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, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap
-
Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition
description, description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, hasCustomIdAssigned, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation
-
-
-
-
Constructor Detail
-
SamplingDefinition
public SamplingDefinition()
-
SamplingDefinition
public SamplingDefinition(String samplePeriod)
-
SamplingDefinition
public SamplingDefinition(Duration period)
-
SamplingDefinition
public SamplingDefinition(long samplePeriod, TimeUnit units)
-
SamplingDefinition
public SamplingDefinition(long messageFrequency)
-
-
Method Detail
-
getShortName
public String getShortName()
-
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 interfaceorg.apache.camel.NamedNode
- Overrides:
getLabel
in classProcessorDefinition<SamplingDefinition>
-
sampleMessageFrequency
public SamplingDefinition sampleMessageFrequency(long messageFrequency)
Sets the sample message count which only a singleExchange
will pass through after this many received.- Parameters:
messageFrequency
- the message frequency- Returns:
- the builder
-
samplePeriod
public SamplingDefinition samplePeriod(Duration samplePeriod)
Sets the sample period during which only a singleExchange
will pass through.- Parameters:
samplePeriod
- the period- Returns:
- the builder
-
samplePeriod
public SamplingDefinition samplePeriod(String samplePeriod)
Sets the sample period during which only a singleExchange
will pass through.- Parameters:
samplePeriod
- the period- Returns:
- the builder
-
samplePeriod
public SamplingDefinition samplePeriod(long samplePeriod)
Sets the sample period during which only a singleExchange
will pass through.- Parameters:
samplePeriod
- the 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)
-
-