kinetic-c  v0.12.0
Seagate Kinetic Protocol Client Library for C
Data Fields
KineticEntry Struct Reference

Kinetic object instance. More...

#include <kinetic_types.h>

Data Fields

ByteBuffer key
 Key associated with the object stored on disk. More...
 
ByteBuffer value
 Value data associated with the key. More...
 
ByteBuffer dbVersion
 Current version of the entry (optional) More...
 
ByteBuffer tag
 Generated authentication hash per the specified algorithm More...
 
KineticAlgorithm algorithm
 Algorithm used to generate the specified tag More...
 
ByteBuffer newVersion
 New version for the object to assume once written to disk (optional) More...
 
bool metadataOnly
 If set for a GET request, will return only the metadata for the specified object (value will not be retrieved) More...
 
bool force
 If set for a GET/DELETE request, will override version checking. More...
 
bool computeTag
 If set and an algorithm is specified, the tag will be populated with the calculated hash for integrity checking. More...
 
KineticSynchronization synchronization
 Synchronization method to use for PUT/DELETE requests. More...
 

Detailed Description

Kinetic object instance.

The ByteBuffer attributes must be allocated and freed by the client, if used.

Definition at line 235 of file kinetic_types.h.

Field Documentation

ByteBuffer KineticEntry::key

Key associated with the object stored on disk.

Definition at line 236 of file kinetic_types.h.

ByteBuffer KineticEntry::value

Value data associated with the key.

Definition at line 237 of file kinetic_types.h.

ByteBuffer KineticEntry::dbVersion

Current version of the entry (optional)

Definition at line 240 of file kinetic_types.h.

ByteBuffer KineticEntry::tag

Generated authentication hash per the specified algorithm

Definition at line 241 of file kinetic_types.h.

KineticAlgorithm KineticEntry::algorithm

Algorithm used to generate the specified tag

Definition at line 242 of file kinetic_types.h.

ByteBuffer KineticEntry::newVersion

New version for the object to assume once written to disk (optional)

Definition at line 245 of file kinetic_types.h.

bool KineticEntry::metadataOnly

If set for a GET request, will return only the metadata for the specified object (value will not be retrieved)

Definition at line 246 of file kinetic_types.h.

bool KineticEntry::force

If set for a GET/DELETE request, will override version checking.

Definition at line 247 of file kinetic_types.h.

bool KineticEntry::computeTag

If set and an algorithm is specified, the tag will be populated with the calculated hash for integrity checking.

Definition at line 248 of file kinetic_types.h.

KineticSynchronization KineticEntry::synchronization

Synchronization method to use for PUT/DELETE requests.

Definition at line 249 of file kinetic_types.h.


The documentation for this struct was generated from the following file: