Type Members

1.  trait AdminApi extends AnyRef

   Maintain catalogs and their configuration.

2.  trait CommitPartition extends javadsl.CommitPartition with PublishPartition with IndexingPartition

   Represent a partition to be committed

   Represent a partition to be committed

   com.here.platform.data.client.scaladsl.CommitPartition.newCommitPartition com.here.platform.data.client.scaladsl.CommitPartition.deletedPartition com.here.platform.data.client.scaladsl.CommitPartition.deletedIndexPartition

3.  trait DataClientApi extends AnyRef

   Abstract trait for DataClient.

   Abstract trait for DataClient.

   This type can be used by applications that want to mock DataClient in unit tests by passing parameters of type DataClientApi instead of accessing the DataClient singleton directly everywhere. For example:

   // Get the DataClientApi passed to functions instead of them accessing the DataClient singleton.
   def logicToTest(dataClient: DataClientApi, ...) = ???
   
   object Application {
      // The application instantiates the real DataClient.
      val dataClient: DataClientApi = DataClient()
      logicToTest(dataClient, ...)
   }
   
   object Test {
      // Tests generate a mock or a stub from the trait.
      val dataClientStub: DataClientApi = stub[DataClientApi]
      logicToTest(dataClientStub, ...)
   }

4.  final class DataClientExt extends DataClientApi with Extension

   Entry point of the Scala data-client module.

   Entry point of the Scala data-client module.

   Use provided API objects to query and publish metadata for catalogs and layers.

   DataEngineExt's provided API objects can later interact with this metadata to upload, or download, actual data to/from the layer's storage.

   Use DataClient.apply to access the global instance.

   Consider passing this global instance as a DataClientApi for unit testing purposes.

5.  final case class DeletedPartition(partition: String, layer: String, dataHandle: Option[String] = None) extends javadsl.DeletedPartition with Product with Serializable

   Represents a deleted partition in a publication.

   Represents a deleted partition in a publication.

   dataHandle

   Only supported by volatile and index Blobstore. If defined, the data will be deleted from the Volume.

6.  trait IndexPartition extends javadsl.IndexPartition with Partition

   Represents a partition of an Index layer.

7.  trait IndexParts extends javadsl.IndexParts
8.  final case class NewPartition(partition: String, layer: String, data: Blob, fields: Option[IndexFields] = None, metadata: Option[IndexMetadata] = None, checksum: Option[String] = None, crc: Option[String] = None, dataSize: Option[Long] = None, compressedDataSize: Option[Long] = None, additionalMetadata: Option[String] = None, timestamp: Option[Long] = None) extends javadsl.NewPartition with Product with Serializable

   Represents a new (or changed) partition pending for publication.

   Represents a new (or changed) partition pending for publication.

   Use the com.here.platform.data.client.scaladsl.NewPartition or com.here.platform.data.client.scaladsl.DeletedPartition to construct instances of this class.

   additionalMetadata is now deprecated because it is no longer required by OLP services to route messages.

   partition

   Name of the partition. If the partition is using a tiling partitioning scheme, this is the id of the tile. The name cannot be empty. Maximum length of this field is 500 characters.

   layer

   Id of the layer. Content of this field must refer to a valid layer already configured in the catalog configuration. Allowed are only: a-z, A-Z, 0-9, '_' and '-' characters. The partition layer cannot be empty. Maximum length is 50 characters.

   data

   Data of new partition.

   fields

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

   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")

   checksum

   The checksum field is optional. It is only included if checksum was requested in the API call (using 'additionalFields' query parameter) and if a checksum was provided during publish of the partition. It should be set to the sha1 checksum of the data content if data comparison needs to work for this catalog. The maximum length of checksum field is 128 characters.

   crc

   The crc field is optional. It is only included if crc was requested in the API call (using 'additionalFields' query parameter) and if a crc was provided during publish of the partition.

   dataSize

   Optional value for the uncompressed size of the partition data in bytes. It is only included if the dataSize field was requested in the API call, and if a dataSize was provided during publish of the partition.

   compressedDataSize

   Optional value for the size of the compressed partition data in bytes. It is only included if the compressedDataSize field was requested in the API call, and if a compressedDataSize was provided during publish of the partition.

   additionalMetadata

   Optional value for additional metadata

   timestamp

   Optional value for the stream record timestamp. Setting the timestamp is only effective when publishing to a stream layer using the kafka-connector. Please check https://developer.here.com/documentation/data-client-library/dev_guide/client/publish-data.html chapter "Publish to a Stream Layer" for the detailed meaning of the timestamp.

9.  final class NotificationSubscription extends AnyRef

   An subscription to a topic with access to the Source of notifications and control operation.

10.  trait NotificationSubscriptionControl extends AnyRef
11.  trait Partition extends javadsl.Partition

    Represent a already committed partition

12.  trait PublishApi extends AnyRef

    Publish partition metadata to a catalog.

13.  trait QueryApi extends AnyRef

    Query partition metadata of a catalog.

14.  trait QueryParts extends javadsl.QueryParts
15.  final case class ReferencePartition(version: Long, partition: String, layer: String, dataHandle: String, checksum: Option[String] = None, crc: Option[String] = None, dataSize: Option[Long] = None, compressedDataSize: Option[Long] = None, additionalMetadata: Option[String] = None, timestamp: Option[Long] = None, checkpoint: Option[CheckpointMark] = None) extends Partition with javadsl.ReferencePartition with ReferenceData with Product with Serializable
16.  final class Subscription extends AnyRef

    An subscription to a stream layer with access to the Source of partitions and control operation.

17.  trait SubscriptionControl extends AnyRef
18.  final case class VersionedPartition(partitionId: String, version: Long) extends Product with Serializable

    Represents a partition of versioned layer

    Represents a partition of versioned layer

    partitionId

    Id of the partition

    version

    version of the partition