com.apple.foundationdb.record.provider.foundationdb

Interface FDBRecord<M extends Message>

Type Parameters:

M - type used to represent stored records

All Known Subinterfaces:

FDBIndexableRecord<M>

All Known Implementing Classes:

FDBIndexedRecord, FDBQueriedRecord, FDBStoredRecord, FDBStoredRecordBuilder, FDBSyntheticRecord

@API(value=STABLE)
public interface FDBRecord<M extends Message>

A record associated with the corresponding meta-data. Adds information about the primary key and record type.

Method Summary

Modifier and Type	Method and Description
Tuple	getPrimaryKey() Get the primary key for this record.
M	getRecord() Get the Protobuf message form of this record.
RecordType	getRecordType() Get the record type for this record.
FDBRecordVersion	getVersion() Get the FDBRecordVersion associated with this record (or null).
boolean	hasVersion() Get whether a FDBRecordVersion has been set for this StoredRecord.

Method Detail

getPrimaryKey

@Nonnull
Tuple getPrimaryKey()

Get the primary key for this record.

Returns:

primary key for this record

getRecordType

@Nonnull
RecordType getRecordType()

Get the record type for this record.

Returns:

record type for this record

getRecord

@Nonnull
M getRecord()

Get the Protobuf message form of this record.

Returns:

the Protobuf message for this record

hasVersion

boolean hasVersion()

Get whether a FDBRecordVersion has been set for this StoredRecord.

Returns:

true if this record has a version

getVersion

@Nullable
FDBRecordVersion getVersion()

Get the FDBRecordVersion associated with this record (or null).

Returns:

the version for this record