Type Members

1.  sealed abstract final class AccessType extends Enum[AccessType]

   Describes types of access a user have to a catalog.

2.  sealed abstract final class AdditionalField extends Enum[AdditionalField]

   Additional fields that can be requested in the API calls.

3.  case class AutomaticVersionDeletion(numberOfVersionsToKeep: Option[Long] = None) extends Product with Serializable
4.  final case class BatchPublicationNotification(version: Long, timestamp: Long) extends Notification with Product with Serializable

   BatchPublicationNotification that is published when ever new batch commit succeeds.

   BatchPublicationNotification that is published when ever new batch commit succeeds.

   version

   Version of new commit

   timestamp

   Timestamp at which commit succeeded (in ms since 01/01/1970 00:00 UTC)

5.  final case class BatchToken(token: String) extends Product with Serializable
   token

   String containing the token.

6.  final case class BooleanIndexValue(value: Boolean) extends IndexValue with Product with Serializable

   Boolean value of index key supported by Index layer

   Boolean value of index key supported by Index layer

   value

   underlying Boolean value

7.  sealed abstract class ByteRange extends AnyRef

   Indicates which part of a resource we are interested in processing.

8.  final case class CatalogAreaSchemeFingerprint(hrn: HRN, version: Int) extends Product with Serializable
9.  final case class CatalogConfiguration(id: String, hrn: HRN, name: String, summary: String, description: String, layers: Seq[Layer], tags: Set[String], owner: Option[Owner], notificationsEnabled: Boolean, billingTags: Set[String], created: ZonedDateTime, version: Long, replication: Replication = Replication(), marketplaceReady: Option[Boolean] = None, automaticVersionDeletion: Option[AutomaticVersionDeletion] = None, areaScheme: Option[HRN] = None, subsetRestrictions: Option[Boolean] = None) extends Product with Serializable
   layers

   The layers property contains version independent information about the layers. Some parts of this configuration may change over time, e.g. the properties of a layer. In this case the detailed handling of changes is described with the parameter. New layer can be added over the time but no layer can be removed. The maximum number of layers in a catalog is 250.

10.  final case class CatalogSubset(id: String, hrn: HRN, name: String, areas: Seq[String], created: ZonedDateTime) extends Product with Serializable
11.  final case class CatalogSubsetsFingerprint(fingerprint: String, subsets: Seq[String], areas: Seq[String], areaScheme: Option[CatalogAreaSchemeFingerprint]) extends Product with Serializable
12.  case class CatalogVersion(hrn: HRN, version: Long) extends Product with Serializable
13.  sealed abstract final class ChangeHistoryDirection extends Enum[ChangeHistoryDirection]
14.  case class CompatibleVersion(version: Long, sharedDependencies: Set[CatalogVersion]) extends Product with Serializable
15.  sealed abstract final class ContentEncoding extends Enum[ContentEncoding]
16.  final case class Coverage(adminAreas: Set[String]) extends Product with Serializable
17.  sealed abstract class CrcAlgorithm extends AnyRef

    Defines a Cyclic redundancy check (CRC) algorithm.

18.  final case class Creator(id: String) extends Product with Serializable
19.  sealed abstract final class DataRedundancy extends Enum[DataRedundancy]
20.  final case class DeleteIndexesRequestId(deleteId: String) extends Product with Serializable
    deleteId

    String containing the delete request id.

21.  final case class DeleteIndexesStatusResponse(deleteId: String, state: String, message: String, count: Int) extends Product with Serializable
    deleteId

    String containing the delete request id.

    state

    The state of the delete request.

    message

    A message describing the state if state is "Failed" otherwise undefined

    count

    Number of deleted index records if state is "Succeeded" otherwise undefined

22.  sealed abstract class DigestAlgorithm extends AnyRef

    Defines a digest algorithm.

23.  sealed trait DigestOption extends AnyRef
24.  final case class EmptyIndexValue(indexType: IndexType) extends IndexValue with Product with Serializable

    EmptyIndexValue signifies the index key does not have a value stored in Index Layer

25.  final case class HereTileIndexValue(tile: Long) extends IndexValue with Product with Serializable

    HereTile value of index key supported by Index layer

    HereTile value of index key supported by Index layer

    tile

    underlying tile id value

26.  final case class HereTilePartitioning(tileLevels: Seq[Int]) extends PartitioningType with Product with Serializable
27.  case class IndexDefinition(name: String, indexType: IndexType, duration: Option[Long] = None, zoomLevel: Option[Int] = None) extends Product with Serializable

    Defines a data attribute for indexing.

    Defines a data attribute for indexing.

    See also IndexLayerType for more information about the index layer.

    name

    name of the attribute

    indexType

    data type of the attribute

    duration

    duration of a TimeWindow attribute in milliseconds, that must be in the range 600000 (10 minutes) .. 86400000 (24h)

    zoomLevel

    size of the tile to which an HereTile attribute applies

    Note

    IndexDefinition.Builder provides Java developers with an easier way of creating IndexDefinitions.

28.  type IndexFields = Map[IndexName, IndexValue]
29.  final case class IndexLayerType(indexDefinitions: Seq[IndexDefinition], ttl: Ttl = Ttl.SevenDays) extends LayerType with Product with Serializable

    Type of an index layer.

    Type of an index layer.

    An index layer is part of an overall solution that enables you to index and store metadata and data in a way that is optimized for batch processing. The index layer itself is, as its name suggests, an index of the catalog’s data by attributes that you can later query.

    IndexLayerType defines the Time to Live (TTL) which is the number of days that records are kept in the layer and available for query.

    IndexLayerType contains IndexDefinition objects that define which attributes are indexed within the layer. Each IndexDefinition has an attribute name and an attribute type IndexType. IndexType defines the types of attributes supported for indexing: Bool, Int, String, HereTile and TimeWindow.

    Important note about IndexDefinition types requirements:

    • An IndexLayerType must contain one and only one IndexDefinition of type IndexType.TimeWindow.
    • An IndexLayerType can contain at most one IndexDefinition of type IndexType.HereTile.
    • The name of each IndexDefinition must be unique.

    See also Index Layers for more information.

    Note

    IndexLayerType.Builder provides Java developers with an easier way of creating IndexLayerTypes.

30.  type IndexMetadata = Map[String, String]
31.  type IndexName = String
32.  sealed abstract final class IndexType extends Enum[IndexType]

    Type of indexes supported for index layer

33.  sealed trait IndexValue extends AnyRef

    A value of index key supported by Index layer.

    A value of index key supported by Index layer.

    The index key is a key that can be used to index partition in Index layer. Index API supports the following types of values: int, bool, string, timewindow, and heretile. The partition indexed by key can be found with query method of QueryAPI by using this key.

34.  final case class IntIndexValue(value: Long) extends IndexValue with Product with Serializable

    The 64 bits integer value of index key supported by Index layer

    The 64 bits integer value of index key supported by Index layer

    value

    underlying 64 bits integer value

35.  sealed abstract final class InteractiveMapContext extends Enum[InteractiveMapContext]
36.  final case class InteractiveMapLayerType(interactiveMapProperties: Option[InteractiveMapProperties] = None) extends LayerType with Product with Serializable
37.  class InteractiveMapOptions extends AnyRef
38.  case class InteractiveMapProperties(searchableProperties: Seq[String], versionsToKeep: Option[Long]) extends Product with Serializable
39.  final case class InteractiveMapSubscriptionConfiguration(interactiveMapSubscriptionType: InteractiveMapSubscriptionType) extends Product with Serializable
40.  sealed abstract class InteractiveMapSubscriptionType extends AnyRef
41.  type JIndexFields = Map[IndexName, IndexValue]
42.  type JIndexMetadata = Map[String, String]
43.  final case class Layer(id: String, name: String, summary: String, description: String, layerType: LayerType, partitioning: PartitioningType, volume: Volume, schema: Option[LayerSchema], contentType: String, contentEncoding: Option[ContentEncoding], tags: Set[String], owner: Option[Owner], billingTags: Set[String], coverage: Option[Coverage], created: ZonedDateTime, digest: Option[DigestAlgorithm], crc: Option[CrcAlgorithm] = None) extends Product with Serializable
    id

    Name of the layer. Allowed characters for the layer name are: a-z, A-Z, 0-9, '_', '-' and '.'. Maximum length of a layer name is 50 characters.

    partitioning

    The partitioning scheme of this layer. Either 'generic' or 'heretile'. 'generic' is for layers that do not have any special relation between the partition names. The other partitioning schemes are defined in more detail in the User Guide.

44.  sealed abstract final class LayerContentType extends Enum[LayerContentType]

    Content type of a layer

45.  case class LayerSchema(hrn: HRN) extends Product with Serializable
46.  sealed trait LayerType extends AnyRef
47.  sealed abstract final class LayerTypeName extends Enum[LayerTypeName]
48.  final case class LayerVersion(layer: String, version: Long, timestamp: Long) extends Product with Serializable
    layer

    Name of the layer.

    version

    Version of the catalog when the layer was last changed. Only versions before and including the requested catalog version are evaluated. Note: version can refer to already retired and thus inaccessible version.

    timestamp

    Timestamp when catalog version was published. (in ms since 01/01/1970 00:00 UTC).

49.  final case class LayerVersions(version: Long, layerVersions: Seq[LayerVersion]) extends Product with Serializable
    version

    Version of this catalog.

    layerVersions

    Layers with their latest version at which data was committed, layers without committed partitions will be omitted.

50.  case class ListCatalogsParams(query: Option[String] = None, accessType: Option[AccessType] = None, coverage: Set[String] = Set.empty, organisation: Option[String] = None, billingTag: Option[String] = None) extends Product with Serializable

    Filters returned results when getting catalogs.

    Filters returned results when getting catalogs.

    query

    part of the value of one or more searchable fields, returning only results that match it

    accessType

    type of access a user has to a catalog

    coverage

    list of countries to look for in the catalog coverage

    organisation

    an organisation the catalog belongs to

    billingTag

    billing tag used by the catalog

51.  sealed abstract final class MaxMemoryPolicy extends Enum[MaxMemoryPolicy]
52.  trait MetricReporter extends AnyRef
53.  sealed trait Notification extends AnyRef
54.  case class ObjectMetadata(lastModified: ZonedDateTime, size: Long, contentType: Option[String], contentEncoding: Option[ContentEncoding]) extends Product with Serializable
    lastModified

    Indicates the time when the object was modified last.

    size

    Size of the object.

55.  case class ObjectMultipartToken(multipartToken: String) extends Product with Serializable
    multipartToken

    Token for multipart.

56.  sealed abstract final class ObjectStoreKeyType extends Enum[ObjectStoreKeyType]
57.  final case class ObjectStoreLayerType() extends LayerType with Product with Serializable
58.  case class ObjectStoreListItem(name: String, keyType: ObjectStoreKeyType, lastModified: Option[ZonedDateTime], size: Option[Long]) extends Product with Serializable
    name

    Name of the key.

    keyType

    Type of the key. It can have two values: [object, commonPrefix]. Object represents complete single key while commonPrefix represents prefix of a key that is delimeted by /.

    lastModified

    Indicates the time when the object was modified last.

    size

    Size of the object.

59.  case class ObjectStoreListing(items: Seq[ObjectStoreListingItem], pageToken: Option[String]) extends Product with Serializable
    items

    List result items.

    pageToken

    Token of the page for which list result is returned.

60.  case class ObjectStoreListingItem(name: String, keyType: String, lastModified: Option[ZonedDateTime], size: Option[Long]) extends Product with Serializable
    name

    Name of the key.

    keyType

    Type of the key. It can have two values: [object, commonPrefix]. Object represents complete single key while commonPrefix represents prefix of a key that is delimeted by /.

    lastModified

    Indicates the time when the object was modified last.

    size

    Size of the object.

61.  case class ObjectStoreUploadResult(parts: Seq[ObjectUploadPart]) extends Product with Serializable
    parts

    Collection of all the uploaded parts.

62.  case class ObjectUploadPart(number: Int, id: String) extends Product with Serializable
    number

    Part number.

    id

    Part id.

63.  final case class Offset(start: Long) extends ByteRange with Product with Serializable

    Indicates that we should process all the bytes from start to end of resource.

64.  final case class Organisation(id: String) extends Product with Serializable
65.  final case class Owner(organisation: Organisation, creator: Creator) extends Product with Serializable

    Holder for information related to ownership of catalog or layer

66.  sealed abstract final class PartitioningScheme extends Enum[PartitioningScheme]

    Partitioning scheme supported by the server

67.  sealed trait PartitioningType extends AnyRef

    Partitioning scheme supported by the server

68.  trait PendingPartition extends AnyRef

    A partition pending for commit, either a new partition, an update to an existing partition, or the deletion of an existing partition.

    A partition pending for commit, either a new partition, an update to an existing partition, or the deletion of an existing partition.

    A new or updated partition is represented by the concrete subclass for - Scala: com.here.platform.data.client.scaladsl.NewPartition or - Java: com.here.platform.data.client.javadsl.NewPartition.

    A partition to be deleted is represented by the concrete subclass for - Scala: com.here.platform.data.client.scaladsl.DeletedPartition or - Java: com.here.platform.data.client.javadsl.DeletedPartition.

    This trait is not designed for custom implementations. The API will reject subtypes not created by the API itself.

69.  final case class Range(start: Long, end: Long) extends ByteRange with Product with Serializable

    Indicates that we should process all the bytes from start to end (inclusive).

70.  final case class RawInteractiveMapSubscriptionConfiguration(type: String) extends Product with Serializable
71.  final case class RawWritableSubscriptionConfiguration(subscriptionName: String, description: Option[String], sourceCatalog: HRN, sourceLayer: String, destinationCatalog: HRN, destinationLayer: String, interactiveMapSubscription: RawInteractiveMapSubscriptionConfiguration) extends Product with Serializable
72.  final case class Region(id: String, role: Option[String]) extends Product with Serializable
73.  final case class Replication(regions: Set[Region] = Set.empty) extends Product with Serializable
74.  sealed trait SchemaOption extends AnyRef
75.  sealed abstract final class SearchOperator extends Enum[SearchOperator]
76.  sealed trait SecureHandlesOption extends AnyRef
77.  final case class StreamLayerType(ttl: Option[Long] = None, streamProperties: Option[StreamProperties] = None) extends LayerType with Product with Serializable
78.  case class StreamProperties(dataInThroughputKbps: Double = -1, dataOutThroughputKbps: Double = -1, parallelization: Option[Int] = None) extends Product with Serializable
79.  final case class StringIndexValue(value: String) extends IndexValue with Product with Serializable

    String value of index key supported by Index layer

    String value of index key supported by Index layer

    value

    underlying String value

80.  final case class SubscriptionConfiguration(subscriptionName: String, subscriptionHrn: HRN, description: Option[String], sourceCatalog: HRN, sourceLayer: String, destinationCatalog: HRN, destinationLayer: String, owner: Owner, version: Int, created: ZonedDateTime, updated: ZonedDateTime, status: SubscriptionPropertiesStatus, interactiveMapSubscription: InteractiveMapSubscriptionConfiguration) extends SubscriptionProperties with Product with Serializable
81.  sealed trait SubsetRestrictionsOption extends AnyRef
82.  final case class TimeWindowIndexValue(time: Long) extends IndexValue with Product with Serializable

    TimeWindow value of index key supported by Index layer

    TimeWindow value of index key supported by Index layer

    time

    underlying timestamp value in milliseconds

83.  sealed abstract final class Ttl extends Enum[Ttl]

    TTL enums for index layer.

    TTL enums for index layer.

    All the values are converted to days. For example, OneMonth is 30 days and OneYear is 365 days.

84.  final case class UpdatableIndexLayer(ttl: Option[Ttl] = None, schema: Option[LayerSchema] = None, digest: Option[DigestAlgorithm] = None, name: Option[String] = None, summary: Option[String] = None, description: Option[String] = None, tags: Option[Set[String]] = None, billingTags: Option[Set[String]] = None, coverage: Option[Coverage] = None) extends UpdatableLayer with DigestOption with SchemaOption with Product with Serializable
85.  final case class UpdatableInteractiveMapLayer(searchableProperties: Option[Seq[String]] = None, versionsToKeep: Option[Long] = None, name: Option[String] = None, summary: Option[String] = None, description: Option[String] = None, tags: Option[Set[String]] = None, billingTags: Option[Set[String]] = None, coverage: Option[Coverage] = None, schema: Option[LayerSchema] = None) extends UpdatableLayer with SchemaOption with Product with Serializable
86.  sealed trait UpdatableLayer extends AnyRef
87.  final case class UpdatableObjectStoreLayer(name: Option[String] = None, summary: Option[String] = None, description: Option[String] = None, tags: Option[Set[String]] = None, billingTags: Option[Set[String]] = None, coverage: Option[Coverage] = None, schema: Option[LayerSchema] = None) extends UpdatableLayer with SchemaOption with Product with Serializable
88.  sealed trait UpdatableSecureHandlesOption extends AnyRef
89.  final case class UpdatableStreamLayer(dataInThroughputKbps: Option[Double] = None, dataOutThroughputKbps: Option[Double] = None, ttl: Option[Long] = None, contentType: Option[String] = None, contentEncoding: Option[ContentEncoding] = None, schema: Option[LayerSchema] = None, name: Option[String] = None, summary: Option[String] = None, description: Option[String] = None, tags: Option[Set[String]] = None, billingTags: Option[Set[String]] = None, coverage: Option[Coverage] = None) extends UpdatableLayer with SchemaOption with Product with Serializable
90.  sealed trait UpdatableSubsetRestrictionsOption extends AnyRef
91.  final case class UpdatableVersionLayer(schema: Option[LayerSchema] = None, digest: Option[DigestAlgorithm] = None, name: Option[String] = None, summary: Option[String] = None, description: Option[String] = None, tags: Option[Set[String]] = None, billingTags: Option[Set[String]] = None, coverage: Option[Coverage] = None, secureHandles: Option[Boolean] = None, subsetRestrictions: Option[Boolean] = None) extends UpdatableLayer with DigestOption with SchemaOption with UpdatableSecureHandlesOption with UpdatableSubsetRestrictionsOption with Product with Serializable
92.  final case class UpdatableVolatileLayer(schema: Option[LayerSchema] = None, digest: Option[DigestAlgorithm] = None, name: Option[String] = None, summary: Option[String] = None, description: Option[String] = None, tags: Option[Set[String]] = None, billingTags: Option[Set[String]] = None, coverage: Option[Coverage] = None, secureHandles: Option[Boolean] = None, subsetRestrictions: Option[Boolean] = None) extends UpdatableLayer with DigestOption with SchemaOption with UpdatableSecureHandlesOption with UpdatableSubsetRestrictionsOption with Product with Serializable
93.  final case class VersionDependency(hrn: HRN, version: Long, direct: Boolean) extends Product with Serializable
    hrn

    HRN of the catalog that was used at any time to generate data for this version of this catalog.

    version

    Version of the catalog that was used as a dependency.

    direct

    Indicates the type of data dependency. If this value is set to false, this dependency is an indirect dependency. This means that data from this catalog was not directly used by a data processing pipeline to update the current version of the catalog.

94.  final case class VersionInfo(version: Long, timestamp: Long, dependencies: Seq[VersionDependency], partitionCounts: Map[String, Long]) extends Product with Serializable
    version

    Version of this catalog.

    timestamp

    Timestamp when catalog version was published. (in ms since 01/01/1970 00:00 UTC).

    dependencies

    List of catalogs and versions that were used as a dependency to generate this version.

    partitionCounts

    The number of partitions changed in this commit for this version, counted by layer.

95.  sealed abstract final class VersionedLayerContext extends Enum[VersionedLayerContext]
96.  final case class VersionedLayerExtension(catalogHrn: HRN, layerId: String) extends Product with Serializable
97.  final case class VersionedLayerProperties(extends: VersionedLayerExtension) extends Product with Serializable
98.  final case class VersionedLayerType(secureHandles: Option[Boolean] = None, subsetRestrictions: Option[Boolean] = None, properties: Option[VersionedLayerProperties] = None) extends LayerType with Product with Serializable
99.  final case class VolatileLayerType(ttl: Option[Long] = None, volatileProperties: Option[VolatileProperties] = None, secureHandles: Option[Boolean] = None, subsetRestrictions: Option[Boolean] = None) extends LayerType with Product with Serializable
100.  case class VolatileProperties(dataRedundancy: DataRedundancy, storageCapacityMb: Long) extends Product with Serializable
101.  final case class VolatileVolume(maxMemoryPolicy: Option[MaxMemoryPolicy] = None) extends Volume with Product with Serializable
102.  sealed trait Volume extends AnyRef
103.  sealed abstract final class VolumeType extends Enum[VolumeType]
104.  final case class WritableCatalogConfiguration(id: String, name: String, summary: String, description: String, layers: Seq[WritableLayer], notificationsEnabled: Boolean = false, tags: Set[String] = Set.empty, hrn: Option[HRN] = None, version: Option[Long] = None, replication: Option[Replication] = None, automaticVersionDeletion: Option[AutomaticVersionDeletion] = None, areaScheme: Option[HRN] = None, subsetRestrictions: Option[Boolean] = None) extends Product with Serializable
105.  final case class WritableLayer(id: String, name: String, summary: String, description: String, layerType: LayerType, partitioning: PartitioningType, volume: Volume, contentType: String = ..., coverage: Option[Coverage] = None, schema: Option[LayerSchema] = None, contentEncoding: Option[ContentEncoding] = None, tags: Set[String] = Set.empty, billingTags: Set[String] = Set.empty, digest: Option[DigestAlgorithm] = None, crc: Option[CrcAlgorithm] = None) extends Product with Serializable
106.  final case class WritableSubscriptionConfiguration(subscriptionName: String, description: Option[String] = None, sourceCatalog: HRN, sourceLayer: String, destinationCatalog: HRN, destinationLayer: String, interactiveMapSubscription: InteractiveMapSubscriptionConfiguration) extends SubscriptionProperties with Product with Serializable