io.confluent.parallelconsumer.state.WorkContainer<K,V>

All Implemented Interfaces:: Comparable<WorkContainer<K,V>>

public class WorkContainer<K,V>
extends Object
implements Comparable<WorkContainer<K,V>>

Constructor Summary

Constructors
Constructor	Description
`WorkContainer(long epoch, org.apache.kafka.clients.consumer.ConsumerRecord<K,V> cr, Function<RecordContext<K,V>,Duration> retryDelayProvider, String workType, Clock clock)`
`WorkContainer(long epoch, org.apache.kafka.clients.consumer.ConsumerRecord<K,V> cr, Function<RecordContext<K,V>,Duration> retryDelayProvider, Clock clock)`

Method Summary

Modifier and Type	Method	Description
`protected boolean`	`canEqual(Object other)`
`int`	`compareTo(WorkContainer o)`
`void`	`endFlight()`
`boolean`	`equals(Object o)`
`org.apache.kafka.clients.consumer.ConsumerRecord<K,V>`	`getCr()`
`Duration`	`getDelayUntilRetryDue()`
`long`	`getEpoch()`	Assignment generation this record comes from.
`Future<List<?>>`	`getFuture()`
`Optional<Instant>`	`getLastFailedAt()`
`Optional<Throwable>`	`getLastFailureReason()`
`Optional<Boolean>`	`getMaybeUserFunctionSucceeded()`
`int`	`getNumberOfFailedAttempts()`
`Duration`	`getRetryDelayConfig()`
`Optional<Instant>`	`getSucceededAt()`
`Duration`	`getTimeInFlight()`
`org.apache.kafka.common.TopicPartition`	`getTopicPartition()`
`String`	`getWorkType()`	Simple way to differentiate treatment based on type
`boolean`	`hasDelayPassed()`
`int`	`hashCode()`
`boolean`	`hasPreviouslyFailed()`
`boolean`	`isAvailableToTakeAsWork()`
`boolean`	`isInFlight()`
`boolean`	`isNotInFlight()`
`boolean`	`isUserFunctionComplete()`
`boolean`	`isUserFunctionSucceeded()`
`long`	`offset()`
`void`	`onQueueingForExecution()`
`void`	`onUserFunctionFailure(Throwable cause)`
`void`	`onUserFunctionSuccess()`
`static void`	`setDefaultRetryDelay(Duration defaultRetryDelay)`
`void`	`setFuture(Future<List<?>> future)`
`void`	`setWorkType(String workType)`	Simple way to differentiate treatment based on type
`String`	`toString()`

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- WorkContainer
  
  public WorkContainer(long epoch, org.apache.kafka.clients.consumer.ConsumerRecord<K,V> cr, Function<RecordContext<K,V>,Duration> retryDelayProvider, String workType, Clock clock)
- WorkContainer
  
  public WorkContainer(long epoch, org.apache.kafka.clients.consumer.ConsumerRecord<K,V> cr, Function<RecordContext<K,V>,Duration> retryDelayProvider, Clock clock)
Method Details
- endFlight
  
  public void endFlight()
- hasDelayPassed
  
  public boolean hasDelayPassed()
- getDelayUntilRetryDue
  
  public Duration getDelayUntilRetryDue()
  
  Returns:
  
  time until it should be retried
- getRetryDelayConfig
  
  public Duration getRetryDelayConfig()
  
  Returns:
  
  the delay between retries e.g. retry after 1 second
- compareTo
  
  public int compareTo(WorkContainer o)
  
  Specified by:
  
  compareTo in interface Comparable<K>
- isNotInFlight
  
  public boolean isNotInFlight()
- isInFlight
  
  public boolean isInFlight()
- onQueueingForExecution
  
  public void onQueueingForExecution()
- getTopicPartition
  
  public org.apache.kafka.common.TopicPartition getTopicPartition()
- onUserFunctionSuccess
  
  public void onUserFunctionSuccess()
- onUserFunctionFailure
  
  public void onUserFunctionFailure(Throwable cause)
- isUserFunctionComplete
  
  public boolean isUserFunctionComplete()
- isUserFunctionSucceeded
  
  public boolean isUserFunctionSucceeded()
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- getTimeInFlight
  
  public Duration getTimeInFlight()
- offset
  
  public long offset()
- hasPreviouslyFailed
  
  public boolean hasPreviouslyFailed()
- isAvailableToTakeAsWork
  
  public boolean isAvailableToTakeAsWork()
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- canEqual
  
  protected boolean canEqual(Object other)
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- getEpoch
  
  public long getEpoch()
  
  Assignment generation this record comes from. Used for fencing messages after partition loss, for work lingering in the system of in flight.
- getWorkType
  
  public String getWorkType()
  
  Simple way to differentiate treatment based on type
- setWorkType
  
  public void setWorkType(String workType)
  
  Simple way to differentiate treatment based on type
- getCr
  
  public org.apache.kafka.clients.consumer.ConsumerRecord<K,V> getCr()
- getNumberOfFailedAttempts
  
  public int getNumberOfFailedAttempts()
- getLastFailedAt
  
  public Optional<Instant> getLastFailedAt()
- getSucceededAt
  
  public Optional<Instant> getSucceededAt()
- getLastFailureReason
  
  public Optional<Throwable> getLastFailureReason()
- getMaybeUserFunctionSucceeded
  
  public Optional<Boolean> getMaybeUserFunctionSucceeded()
- setDefaultRetryDelay
  
  public static void setDefaultRetryDelay(Duration defaultRetryDelay)
  
  See Also:
  
  ParallelConsumerOptions.getDefaultMessageRetryDelay()
- getFuture
  
  public Future<List<?>> getFuture()
- setFuture
  
  public void setFuture(Future<List<?>> future)

Class WorkContainer<K,​V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details

Class WorkContainer<K,V>