Record Class IndexingLedgerPoller.CrawlProgress

java.lang.Object
java.lang.Record
ai.pipestream.module.pipelineprobe.pipelinecrawl.IndexingLedgerPoller.CrawlProgress
Record Components:
total - total ledger rows recorded for the crawl
success - docs OSM indexed successfully
partialSuccess - docs OSM indexed with partial success
failedTerminal - docs that hard-failed and will not be retried
failedRetrying - docs that failed but are still being retried
skipped - docs OSM skipped
inFlight - docs still being processed (not yet terminal)
Enclosing class:
IndexingLedgerPoller
public static record IndexingLedgerPoller.CrawlProgress(int total, int success, int partialSuccess, int failedTerminal, int failedRetrying, int skipped, int inFlight) extends Record
Receipt counts for one crawl, partitioned the way the run report wants them. terminal() is "OSM is done with this doc" regardless of how it ended.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CrawlProgress(int total, int success, int partialSuccess, int failedTerminal, int failedRetrying, int skipped, int inFlight)
    Creates an instance of a CrawlProgress record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    failed()
    Docs that ended in a state the e2e should call a failure.
    int
    failedRetrying()
    Returns the value of the failedRetrying record component.
    int
    failedTerminal()
    Returns the value of the failedTerminal record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    inFlight()
    Returns the value of the inFlight record component.
    int
    partialSuccess()
    Returns the value of the partialSuccess record component.
    int
    skipped()
    Returns the value of the skipped record component.
    int
    success()
    Returns the value of the success record component.
    int
    terminal()
    Docs OSM has finished with — success, partial, hard-failed, or skipped.
    final String
    toString()
    Returns a string representation of this record class.
    int
    total()
    Returns the value of the total record component.

    Methods inherited from class Object

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

  • Constructor Details

    • CrawlProgress

      public CrawlProgress(int total, int success, int partialSuccess, int failedTerminal, int failedRetrying, int skipped, int inFlight)
      Creates an instance of a CrawlProgress record class.
      Parameters:
      total - the value for the total record component
      success - the value for the success record component
      partialSuccess - the value for the partialSuccess record component
      failedTerminal - the value for the failedTerminal record component
      failedRetrying - the value for the failedRetrying record component
      skipped - the value for the skipped record component
      inFlight - the value for the inFlight record component

  • Method Details

    • terminal

      public int terminal()
      Docs OSM has finished with — success, partial, hard-failed, or skipped.
      Returns:
      the count of docs OSM has reached a terminal state for

    • failed

      public int failed()
      Docs that ended in a state the e2e should call a failure.
      Returns:
      the count of hard-failed (terminal) docs

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • total

      public int total()
      Returns the value of the total record component.
      Returns:
      the value of the total record component

    • success

      public int success()
      Returns the value of the success record component.
      Returns:
      the value of the success record component

    • partialSuccess

      public int partialSuccess()
      Returns the value of the partialSuccess record component.
      Returns:
      the value of the partialSuccess record component

    • failedTerminal

      public int failedTerminal()
      Returns the value of the failedTerminal record component.
      Returns:
      the value of the failedTerminal record component

    • failedRetrying

      public int failedRetrying()
      Returns the value of the failedRetrying record component.
      Returns:
      the value of the failedRetrying record component

    • skipped

      public int skipped()
      Returns the value of the skipped record component.
      Returns:
      the value of the skipped record component

    • inFlight

      public int inFlight()
      Returns the value of the inFlight record component.
      Returns:
      the value of the inFlight record component