Package org.apache.polaris.persistence.nosql.api.obj

Interface Obj

All Known Subinterfaces:

BaseCommitObj

All Known Implementing Classes:

GenericObj

public interface Obj

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Obj.Builder<O extends Obj,B extends Obj.Builder<O,B>>
static class	Obj.ObjSerializeAll
static class	Obj.StorageView	The Jackson view used when Objs are serialized to be persisted.

Method Summary

Modifier and Type	Method	Description
default long	createdAtMicros()	Contains the timestamp in microseconds since (Unix) epoch when the object was last written, only intended for repository cleanup mechanisms.
long	id()
default int	numParts()	Indicates the number of parts of which the object is split in the backing database.
ObjType	type()
String	versionToken()	Opaque token used for objects when persisted using conditional inserts, updates or deletes.
Obj	withCreatedAtMicros(long createdAt)
Obj	withNumParts(int numParts)

Method Details

type

ObjType type()

id

long id()

numParts

@Default
default int numParts()

Indicates the number of parts of which the object is split in the backing database. This value is available after the object has been written.

createdAtMicros

@Default
@Auxiliary
default long createdAtMicros()

Contains the timestamp in microseconds since (Unix) epoch when the object was last written, only intended for repository cleanup mechanisms.

The value of this attribute is generated exclusively by the Persistence implementations.

This attribute is not consistent when using a caching Persistence.

versionToken

@Nullable
String versionToken()

Opaque token used for objects when persisted using conditional inserts, updates or deletes.

This value must be null for non-conditional operations and must be non-null when used for conditional operations.

withCreatedAtMicros

@Nonnull
Obj withCreatedAtMicros(long createdAt)

withNumParts

@Nonnull
Obj withNumParts(int numParts)