Package io.oxia.client.api

Record Class PutResult

Object
Record
PutResult
Record Components:
key - the effective key stored in Oxia
version - metadata describing the record after the put was applied (use Version.versionId() for subsequent conditional writes)
public record PutResult(String key, Version version) extends Record
The result of a successful put operation.

The key returned here is the effective key stored on the server. It usually matches the key supplied to the put call; with sequence-key options the server assigns the key, so callers must use this value to read the record back.

  • Constructor Details

    • PutResult

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

  • Method Details

    • 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 Objects::equals(Object,Object).
      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.

    • key

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

    • version

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