Package io.oxia.client.api

Record Class GetResult

Object
Record
GetResult
Record Components:
key - the key of the record returned by the server (may differ from the key supplied to get when a non-equal comparison is used)
value - the record's value, or null if the value was not requested
version - metadata describing the record at the time it was read
public record GetResult(String key, byte[] value, Version version) extends Record
The result of a successful get / range-scan operation.

A null GetResult from a get call signals that no record exists for the requested key. When GetOption.ExcludeValue is used, the value field will be null but key and version are still populated.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GetResult(String key, byte[] value, Version version)
    Creates an instance of a GetResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    key()
    Returns the value of the key record component.
    final String
    toString()
    Returns a string representation of this record class.
    byte[]
    value()
    Returns the value of the value record component.
    Version
    version()
    Returns the value of the version record component.

    Methods inherited from class Object

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

  • Constructor Details

    • GetResult

      public GetResult(String key, byte[] value, Version version)
      Creates an instance of a GetResult record class.
      Parameters:
      key - the value for the key record component
      value - the value for the value record component
      version - the value for the version record component

  • Method Details

    • equals

      public boolean equals(Object obj)
      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 Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      obj - the object with which to compare
      Returns:
      true if this object is the same as the obj argument; false otherwise.

    • 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

    • key

      public String key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • value

      public byte[] value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component

    • version

      public Version version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component