luciano/amazon-kinesis-client
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Cleanup the Writing of the IdleTimeBetweenMillis Documentation

Browse source
This commit is contained in:
Pfifer, Justin 2017-05-19 08:29:42 -07:00 committed by Justin Pfifer
parent e12ff541f7
commit e121691ac2
1 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/main/java/com/amazonaws/services/kinesis/clientlibrary/lib/worker/KinesisClientLibConfiguration.java
View file

@ -791,12 +791,12 @@ public class KinesisClientLibConfiguration {
} }
/** /**
* Controls how long the {@link ShardConsumer} will sleep if no records are returned from the call to * Controls how long the KCL will sleep if no records are returned from Kinesis
* {@link com.amazonaws.services.kinesis.AmazonKinesis#getRecords(com.amazonaws.services.kinesis.model.GetRecordsRequest)}.
* *
* This sleep is only used when no records are returned. If records are returned the {@link ShardConsumer} will * <p>
* This value is only used when no records are returned; if records are returned, the {@link com.amazonaws.services.kinesis.clientlibrary.lib.worker.ProcessTask} will
* immediately retrieve the next set of records after the call to * immediately retrieve the next set of records after the call to
* {@link com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IRecordProcessor#processRecords(com.amazonaws.services.kinesis.clientlibrary.types.ProcessRecordsInput)} * {@link com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IRecordProcessor#processRecords(ProcessRecordsInput)}
* has returned. Setting this value to high may result in the KCL being unable to catch up. If you are changing this * has returned. Setting this value to high may result in the KCL being unable to catch up. If you are changing this
* value it's recommended that you enable {@link #withCallProcessRecordsEvenForEmptyRecordList(boolean)}, and * value it's recommended that you enable {@link #withCallProcessRecordsEvenForEmptyRecordList(boolean)}, and
* monitor how far behind the records retrieved are by inspecting * monitor how far behind the records retrieved are by inspecting
@ -804,11 +804,10 @@ public class KinesisClientLibConfiguration {
* <a href= * <a href=
* "http://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html#kinesis-metrics-stream">CloudWatch * "http://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html#kinesis-metrics-stream">CloudWatch
* Metric: GetRecords.MillisBehindLatest</a> * Metric: GetRecords.MillisBehindLatest</a>
* </p>
* *
* @param idleTimeBetweenReadsInMillis * @param idleTimeBetweenReadsInMillis
* how long to sleep calls to * how long to sleep between GetRecords calls when no records are returned.
* {@link com.amazonaws.services.kinesis.AmazonKinesis#getRecords(com.amazonaws.services.kinesis.model.GetRecordsRequest)}
* when no records are returned.
* @return KinesisClientLibConfiguration * @return KinesisClientLibConfiguration
*/ */
public KinesisClientLibConfiguration withIdleTimeBetweenReadsInMillis(long idleTimeBetweenReadsInMillis) { public KinesisClientLibConfiguration withIdleTimeBetweenReadsInMillis(long idleTimeBetweenReadsInMillis) {