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

Class GenericObj

java.lang.Object

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

All Implemented Interfaces:

Obj

@PolarisImmutable
public abstract class GenericObj
extends Object
implements Obj

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.polaris.persistence.nosql.api.obj.Obj

Obj.Builder<O extends Obj,B extends Obj.Builder<O,B>>, Obj.ObjSerializeAll, Obj.StorageView

Constructor Summary

Constructors

Constructor	Description
GenericObj()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.polaris.persistence.nosql.api.obj.Obj

withCreatedAtMicros, withNumParts

Constructor Details

GenericObj

public GenericObj()

Method Details

type

public abstract ObjType type()

Specified by:

type in interface Obj

id

public abstract long id()

Specified by:

id in interface Obj

numParts

public abstract int numParts()

Description copied from interface: Obj

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.

Specified by:

numParts in interface Obj

createdAtMicros

@Auxiliary
public abstract long createdAtMicros()

Description copied from interface: Obj

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.

Specified by:

createdAtMicros in interface Obj

versionToken

@Nullable
public abstract String versionToken()

Description copied from interface: Obj

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.

Specified by:

versionToken in interface Obj

attributes

@AllowNulls
public abstract Map<String,Object> attributes()