Package com.helixframework.api.contract.batch

Class BatchSummary

java.lang.Object
com.helixframework.api.contract.batch.BatchSummary
public class BatchSummary extends Object
Represents a summary of a batch response. The BatchSummary class contains the total number of items, the number of successful items, and the number of failed items in the batch.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BatchSummary(long total, long success, long failed)
    Represents a summary of a batch response.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getFailed()
    Returns the number of failed items in the batch summary.
    long
    getSuccess()
    Returns the number of successful items in a batch response summary.
    long
    getTotal()
    Returns the total count of items.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • BatchSummary

      public BatchSummary(long total, long success, long failed)
      Represents a summary of a batch response. The BatchSummary class contains the total number of items, the number of successful items, and the number of failed items in the batch.
      Parameters:
      total - The total count of items.
      success - The number of successful items.
      failed - The number of failed items.

  • Method Details

    • getTotal

      public long getTotal()
      Returns the total count of items.
      Returns:
      the total count of items

    • getSuccess

      public long getSuccess()
      Returns the number of successful items in a batch response summary.
      Returns:
      the number of successful items

    • getFailed

      public long getFailed()
      Returns the number of failed items in the batch summary.
      Returns:
      the number of failed items