Class BatchRead

java.lang.Object
com.aerospike.client.BatchRead

public final class BatchRead
extends Object
Key and bin names used in batch read commands where variables bins are needed for each key.
  • Field Summary

    Fields 
    Modifier and Type Field Description
    String[] binNames
    Bins to retrieve for this key.
    Key key
    Key.
    boolean readAllBins
    If true, ignore binNames and read all bins.
    Record record
    Record result after batch command has completed.
  • Constructor Summary

    Constructors 
    Constructor Description
    BatchRead​(Key key, boolean readAllBins)
    Initialize batch key and readAllBins indicator.
    BatchRead​(Key key, String[] binNames)
    Initialize batch key and bins to retrieve.
  • Method Summary

    Modifier and Type Method Description
    String toString()
    Convert BatchRead to string.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

    • key

      public final Key key
      Key.
    • binNames

      public final String[] binNames
      Bins to retrieve for this key.
    • readAllBins

      public final boolean readAllBins
      If true, ignore binNames and read all bins. If false and binNames are set, read specified binNames. If false and binNames are not set, read record header (generation, expiration) only.
    • record

      public Record record
      Record result after batch command has completed. Will be null if record was not found.
  • Constructor Details

    • BatchRead

      public BatchRead​(Key key, String[] binNames)
      Initialize batch key and bins to retrieve.
      Parameters:
      key - record key
      binNames - array of bins to retrieve.
    • BatchRead

      public BatchRead​(Key key, boolean readAllBins)
      Initialize batch key and readAllBins indicator.
      Parameters:
      key - record key
      readAllBins - should all bins in record be retrieved.
  • Method Details