Package io.deephaven.kv.meta

Class UpdateInfo

java.lang.Object
io.deephaven.kv.meta.UpdateInfo
public class UpdateInfo extends Object
Update info should be present with every update to the kv store. It represents the user level metadata that should be present.

This works hand in hand with the atomic model (see AtomicDirectoryContext), where UpdateInfos are constructed.

  • Method Details

    • getUser

      public String getUser()
      The user is the end-user that initiated the request. In the case of autonomous updates from the system, a fake user should be specified.

      The user String isn't inherently tied in with the notion of an authenticated user, nor ACLs. The higher level application(s) can provide a more opininionated view on this field.

    • getCode

      public String getCode()
      The code is an identifier that makes it easy to reference the code-path that created the update. A human-readable code is acceptable, but a fixed-randomly-generated identifier may be best.

    • getTimestamp

      public Instant getTimestamp()
      The timestamp is the time at which this request was initiated.

    • getComment

      public String getComment()
      The comment is an end-user specified comment about the update. In the case of autonomous updates from the system, a relevant comment should be specified. It is similar in spirit to a VCS commit message.

    • getWrt

      public KeyPath getWrt()
      The wrt (with-respect-to) path is the level of atomicity that is expected for this update.

      See AtomicDirectoryContext for more information on atomicity.

    • getWrtModRevision

      public OptionalLong getWrtModRevision()
      The wrtModRevision is the expected mod-rev of the wrt path. An empty wrtModRevision means that the wrt path is expected to not exist yet.

      See AtomicDirectoryContext for more information on atomicity.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object