Package com.here.platform.data.client.javadsl

Class IndexPartition

java.lang.Object

com.here.platform.data.client.javadsl.IndexPartition

All Implemented Interfaces:

Partition, Serializable

public abstract class IndexPartition
extends Object
implements Partition

Represents a partition of Index layer.

Instances of this class are returned by QueryApi.queryIndex, each of which can be used to download partition data using ReadEngine.get.

IndexPartition objects encapsulate the following properties:

• layer, layer name of the index partition
• dataHandle, data handle of the index partition
• fields, collection of index fields of the index partition
• metadata, optional user-defined fields that can store extra metadata about this index record. A typical example of extra metadata is the ingestion time of a record, Map("ingestionTime" -> "1532018660873")
• timestamp, optional value for the timestamp of the index partition
• checksum, optional value for the checksum of the index partition data
• crc, optional value for the crc of the index partition data
• dataSize, optional value for the uncompressed size of the index partition data in bytes
• compressedDataSize, optional value for the compressed size of the index partition data in bytes

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IndexPartition.Builder	Builder of IndexPartition that represents a partition of Index layer.

Constructor Summary

Constructors

Constructor	Description
IndexPartition()

Method Summary

Modifier and Type	Method	Description
abstract String	getDataHandle()	Unique identifier of index partition data.
abstract Optional<Map<String,IndexValue>>	getFields()	Index fields.
abstract Optional<Map<String,String>>	getMetadata()	Optional user-defined fields that can store extra metadata about this index record.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.here.platform.data.client.javadsl.Partition

getAdditionalMetadata, getCheckpoints, getChecksum, getCompressedDataSize, getCrc, getDataSize, getLayer, getPartition, getTimestamp, isDeleted

Constructor Details

IndexPartition

public IndexPartition()

Method Details

getDataHandle

public abstract String getDataHandle()

Unique identifier of index partition data.

getFields

public abstract Optional<Map<String,IndexValue>> getFields()

Index fields.

It's collection of name-value pairs to index partition in Index layer.

getMetadata

public abstract Optional<Map<String,String>> getMetadata()

Optional user-defined fields that can store extra metadata about this index record. A typical example of extra metadata is the ingestion time of a record, Map("ingestionTime" -> "1532018660873")