trait QueryApi extends AnyRef
Query partition metadata of a catalog.
- Alphabetic
- By Inheritance
- QueryApi
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
getChanges(startVersion: Long, endVersion: Long, layer: String, additionalFields: Set[AdditionalField] = Set.empty, partId: Option[String] = None, context: VersionedLayerContext = VersionedLayerContext.DEFAULT): Future[Source[Partition, NotUsed]]
Get metadata for the latest partition changes for a version range in a versioned layer.
Get metadata for the latest partition changes for a version range in a versioned layer. Only the latest change for each changed partition is returned, not intermediate changes. If the response contains a partition with an empty 'dataHandle' value, the partition was deleted at the version indicated by the 'version' field of the partition object. If a partition was created and deleted between the versions specified in the 'startVersion' and 'endVersion' parameters, the partition is not included in the response. For example, if you request versions 0 to 10, and a partition was created in version 3 then deleted in version 7, it is not included in the response.
Source returned by this function *MUST BE* consumed. If accidentally left not fully consumed it will be assumed the incoming data should remain back-pressured, and will stall the incoming data via TCP back-pressure mechanisms. Such stall connection can exhaust DataClient connection pool.
- startVersion
Start version (exclusive). If the version specified has been deleted, the lowest existing version is assumed. This parameter cannot be null.
- endVersion
End version (inclusive). Must be greater than
startVersion.- layer
Layer id to be used for filtering. If the layer specified in request does not exist, an error is returned.
- additionalFields
If this parameter is set, the fields set during commit of the tile will be included in the response. metadata for partitions changed between versions
- partId
Indicates which part of the layer shall be queried.
- context
The context where the operation will be performed on a composite layer.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getChangesAsIterator(startVersion: Long, endVersion: Long, layer: String, additionalFields: Set[AdditionalField] = Set.empty, partId: Option[String] = None, context: VersionedLayerContext = VersionedLayerContext.DEFAULT): Future[Iterator[Partition]]
Get metadata for the latest partition changes for a version range in a versioned layer.
Get metadata for the latest partition changes for a version range in a versioned layer. Only the latest change for each changed partition is returned, not intermediate changes. If the response contains a partition with an empty 'dataHandle' value, the partition was deleted at the version indicated by the 'version' field of the partition object. If a partition was created and deleted between the versions specified in the 'startVersion' and 'endVersion' parameters, the partition is not included in the response. For example, if you request versions 0 to 10, and a partition was created in version 3 then deleted in version 7, it is not included in the response.
Fetch elements from the iterator may be a blocking call.
Iterator returned by this function *MUST BE* consumed. If accidentally left not fully consumed it will be assumed the incoming data should remain back-pressured, and will stall the incoming data via TCP back-pressure mechanisms. Such stall connection can exhaust DataClient connection pool.
- startVersion
Start version (exclusive). If the version specified has been deleted, the lowest existing version is assumed. This parameter cannot be null.
- endVersion
End version (inclusive). Must be greater than
startVersion.- layer
Layer id to be used for filtering. If the layer specified in request does not exist, an error is returned.
- additionalFields
If this parameter is set, the fields set during commit of the tile will be included in the response. metadata for partitions changed between versions
- partId
Indicates which part of the layer shall be queried.
- context
The context where the operation will be performed on a composite layer.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getChangesById(startVersion: Long, endVersion: Long, layer: String, partitions: Seq[String], additionalFields: Set[AdditionalField] = Set.empty, context: VersionedLayerContext = VersionedLayerContext.DEFAULT): Future[Seq[Partition]]
Get metadata for the latest partition changes for a version range in a versioned layer.
Get metadata for the latest partition changes for a version range in a versioned layer. Only the latest change for each changed partition is returned, not intermediate changes. If the response contains a partition with an empty 'dataHandle' value, the partition was deleted at the version indicated by the 'version' field of the partition object. If a partition was created and deleted between the versions specified in the 'startVersion' and 'endVersion' parameters, the partition is not included in the response. For example, if you request versions 0 to 10, and a partition was created in version 3 then deleted in version 7, it is not included in the response.
- startVersion
Start version (exclusive). If the version specified has been deleted, the lowest existing version is assumed. This parameter cannot be null.
- endVersion
End version (inclusive). Must be greater than
startVersion.- layer
Layer id to be used for filtering. If the layer specified in request does not exist, an error is returned.
- partitions
Partition names to be used for filtering. If a partition specified in the request does not exist, it is skipped in the response.
- additionalFields
If this parameter is set, the fields set during commit of the tile will be included in the response.
- context
The context where the operation will be performed on a composite layer.
- returns
metadata for partitions changed between versions
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getChangesParts(layer: String, parts: Int): Future[QueryParts]
Returns QueryParts which represent the layer parts that can be used to limit the scope of a query operation This allows to run parallel queries with multiple parts.
Returns QueryParts which represent the layer parts that can be used to limit the scope of a query operation This allows to run parallel queries with multiple parts. The user has to provide the desired number of parts and the service will return a list of Part Ids. Please note in some cases the requested number of parts will make them too small and in this case the service might return lesser amount of the parts than requested.
- layer
Layer ID of the queried index layer
- parts
Indicates requested number of layer parts. User can split the single large query into multiple parts.
- Exceptions thrown
java.lang.IllegalArgumentExceptionif the layer does not exist
-
abstract
def
getCompatibleVersionsAsIterator(dependencies: Set[CatalogVersion]): Future[Iterator[CompatibleVersion]]
Gets a list of available catalog versions selected under the given dependencies
Gets a list of available catalog versions selected under the given dependencies
Returns a list of versions of this catalog with one of the following properties:
- the listed HRNs for these versions are present in the direct or indirect dependencies with the same version
- these HRNs are not present
Please note that versions that don't depend on any of the provided catalog HRNs are also considered compatible. The compatible versions are returned in reverse order, from the newest to the oldest.
- dependencies
The catalog dependencies we want to search for
- returns
a list of compatible versions
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable errorcom.here.platform.data.client.NotFoundExceptionwhen catalog does not exist or the catalog doesn't contain any versions
-
abstract
def
getConfiguration(): Future[CatalogConfiguration]
Get catalog configuration.
Get catalog configuration.
- returns
configuration of the catalog
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getFeatureChanges(layerId: String, startVersion: Long, endVersion: Long, limit: Option[Int] = None): Future[Source[(Long, Changeset), NotUsed]]
Retrieves the existing Changesets from the layer.
Retrieves the existing Changesets from the layer. Each successful write transaction to the layer is stored as one single Changeset, which can contain modifications applied to one or more features.
Source returned by this function *MUST BE* consumed. If accidentally left not fully consumed it will be assumed the incoming data should remain back-pressured, and will stall the incoming data via TCP back-pressure mechanisms. Such stall connection can exhaust DataClient connection pool.
- layerId
Layer id to be used for filtering. If the layer specified in request does not exist, an error is returned.
- startVersion
Define start of version-range [version >= startVersion].
- endVersion
Define end of version-range [version <= endVersion]
- limit
The maximum number of features in the response. Default is 30000. Hard limit is 100000.
- returns
source of pairs of version and its corresponding changeset
-
abstract
def
getFeatureChangesByVersion(layerId: String, version: Long, limit: Option[Int] = None): Future[Changeset]
Retrieves one Changeset from the layer by version.
Retrieves one Changeset from the layer by version.
- layerId
Layer id to be used for filtering. If the layer specified in request does not exist, an error is returned.
- version
The version of a Changeset.
- limit
The maximum number of features in the response. Default is 30000. Hard limit is 100000.
- returns
the Changeset corresponding to the version
-
abstract
def
getFeatureChangesStatistics(layerId: String): Future[ChangesetStatistics]
Returns statistics about changesets in a layer.
Returns statistics about changesets in a layer.
- layerId
Layer id to be used for filtering. If the layer specified in request does not exist, an error is returned.
- returns
the statistics about changesets in the layer identified with layerId
-
abstract
def
getFeatureCollectionByBbox(layerId: String, bbox: BoundingBox, searchParam: Set[SearchParam] = Set.empty, selection: Set[String] = Set.empty, limit: Option[Int] = None, context: Option[InteractiveMapContext] = None, version: Option[Long] = None): Future[FeatureCollection]
Returns the features which are inside a bounding box of the interactiveMap layer.
Returns the features which are inside a bounding box of the interactiveMap layer.
- layerId
Layer ID of the queried interactiveMap layer.
- bbox
The bounding box in which the features needs to be searched; for meaning of bbox coordinates see https://developer.here.com/documentation/data-client-library/dev_guide/client/publish-data.html#interactive-layer-coords
- searchParam
List of additional feature filters resulting in a subset of features.
Allowed prefixes to be used for property search are:- 'p.' - used to access values stored in 'properties' property of the feature
- 'f.' - used to access values which are added by default in the stored feature, the possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'.
Example - p.property_1=property_value_1 or f.special_property_1=special_property_value_1 The available operators are: - "=" - equals
- "!=" - not equals
- ">=" or "=gte=" - greater than or equals
- "<=" or "=lte=" - less than or equals
- ">" or "=gt=" - greater than
- "<" or "=lt=" - less than
- "@>" or "=cs=" - contains
- selection
List of properties to be returned in the features result list. Example, 'p.property_name'.
- limit
The maximum number of features in the response (Default is 30000).
- context
The context where the operation will be performed on a composite layer. If not specified, the operation occurs based on the extension rules.
- version
The version of the feature collection
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable error.com.here.platform.data.client.DataClientRetriableExceptionin case of retriable error.java.lang.IllegalArgumentExceptionif the layer does not exist or is not an interactiveMap layer.
-
abstract
def
getFeatureCollectionByIds(layer: String, ids: Seq[String], selection: Set[String] = Set.empty, context: Option[InteractiveMapContext] = None, version: Option[Long] = None, author: Option[String] = None): Future[FeatureCollection]
Returns all the features found for the provided list of IDs in the interactiveMap layer.
Returns all the features found for the provided list of IDs in the interactiveMap layer.
- layer
Layer ID of the queried interactiveMap layer
- ids
List of feature IDs to be retrieved fom the interactiveMap layer
- selection
List of properties to be returned in the features result list. Example, 'p.property_name'
- context
The context where the operation will be performed on a composite layer. If not specified, the operation occurs based on the extension rules.
- version
The version of the feature collection
- author
The author of the feature collection
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable errorjava.lang.IllegalArgumentExceptionif the layer does not exist
-
abstract
def
getFeatureCollectionByIterate(layerId: String, pageToken: Option[String] = None, selection: Set[String] = Set.empty, limit: Option[Int] = None, context: Option[InteractiveMapContext] = None, version: Option[Long] = None): Future[FeatureCollection]
Returns the features by iterating over all the features in the interactiveMap layer.
Returns the features by iterating over all the features in the interactiveMap layer.
- layerId
Layer ID of the queried interactiveMap layer.
- pageToken
The page token where the iteration will continue.
- selection
List of properties to be returned in the features result list. Example, 'p.property_name'.
- limit
The maximum number of features in the response (Default is 30000).
- context
The context where the operation will be performed on a composite layer. If not specified, the operation occurs based on the extension rules.
- version
The version of the feature collection
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable error.com.here.platform.data.client.DataClientRetriableExceptionin case of retriable error.java.lang.IllegalArgumentExceptionif the layer does not exist or is not an interactiveMap layer.
-
abstract
def
getFeatureCollectionBySearchParam(layerId: String, searchParam: Set[SearchParam], selection: Set[String] = Set.empty, limit: Option[Int] = None, context: Option[InteractiveMapContext] = None, version: Option[Long] = None, author: Option[String] = None): Future[FeatureCollection]
Returns the features by search params from the interactiveMap layer.
Returns the features by search params from the interactiveMap layer.
- layerId
Layer ID of the queried interactiveMap layer.
- searchParam
List of additional feature filters resulting in a subset of features.
Allowed prefixes to be used for property search are:- 'p.' - used to access values stored in 'properties' property of the feature
- 'f.' - used to access values which are added by default in the stored feature, the possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'.
Example - p.property_1=property_value_1 or f.special_property_1=special_property_value_1 The available operators are: - "=" - equals
- "!=" - not equals
- ">=" or "=gte=" - greater than or equals
- "<=" or "=lte=" - less than or equals
- ">" or "=gt=" - greater than
- "<" or "=lt=" - less than
- "@>" or "=cs=" - contains
- selection
List of properties to be returned in the features result list. Example, 'p.property_name'.
- limit
The maximum number of features in the response (Default is 30000).
- context
The context where the operation will be performed on a composite layer. If not specified, the operation occurs based on the extension rules.
- version
The version of the feature collection
- author
The author of the feature collection
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable error.com.here.platform.data.client.DataClientRetriableExceptionin case of retriable error.java.lang.IllegalArgumentExceptionif the layer does not exist or is not an interactiveMap layer.
-
abstract
def
getFeatureCollectionBySpatialSearchCircle(layerId: String, latitude: Double, longitude: Double, radius: Int, searchParam: Set[SearchParam] = Set.empty, selection: Set[String] = Set.empty, limit: Option[Int] = None, context: Option[InteractiveMapContext] = None, version: Option[Long] = None): Future[FeatureCollection]
Returns the features which are inside the specified circle with specified latitude and longitude as center.
Returns the features which are inside the specified circle with specified latitude and longitude as center.
- layerId
Layer ID of the queried interactiveMap layer.
- latitude
The latitude in WGS'84 decimal degree (-90 to +90) of the center Point.
- longitude
The longitude in WGS'84 decimal degree (-180 to +180) of the center Point.
- radius
Radius in meter of the circle.
- searchParam
List of additional feature filters resulting in a subset of features.
Allowed prefixes to be used for property search are:- 'p.' - used to access values stored in 'properties' property of the feature
- 'f.' - used to access values which are added by default in the stored feature, the possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'.
Example - p.property_1=property_value_1 or f.special_property_1=special_property_value_1 The available operators are: - "=" - equals
- "!=" - not equals
- ">=" or "=gte=" - greater than or equals
- "<=" or "=lte=" - less than or equals
- ">" or "=gt=" - greater than
- "<" or "=lt=" - less than
- "@>" or "=cs=" - contains
- selection
List of properties to be returned in the features result list. Example, 'p.property_name'.
- limit
The maximum number of features in the response (Default is 30000).
- context
The context where the operation will be performed on a composite layer. If not specified, the operation occurs based on the extension rules.
- version
The version of the feature collection
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable error.com.here.platform.data.client.DataClientRetriableExceptionin case of retriable error.java.lang.IllegalArgumentExceptionif the layer does not exist or is not an interactiveMap layer.
-
abstract
def
getFeatureCollectionBySpatialSearchFeature(layerId: String, refCatalogHrn: String, refLayerId: String, refFeatureId: String, radius: Option[Int], searchParam: Set[SearchParam] = Set.empty, selection: Set[String] = Set.empty, limit: Option[Int] = None, context: Option[InteractiveMapContext] = None, version: Option[Long] = None): Future[FeatureCollection]
Returns the features which intersects the specified reference feature's geometry.
Returns the features which intersects the specified reference feature's geometry.
- layerId
Layer ID of the queried interactiveMap layer.
- refCatalogHrn
The catalog HRN where the layer containing the referenced feature is stored.
- refLayerId
The layer id where the referenced feature is stored.
- refFeatureId
The feature ID in the referenced layer.
- radius
Radius in meter which is added as buffer to the geometry.
- searchParam
List of additional feature filters resulting in a subset of features.
Allowed prefixes to be used for property search are:- 'p.' - used to access values stored in 'properties' property of the feature
- 'f.' - used to access values which are added by default in the stored feature, the possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'.
Example - p.property_1=property_value_1 or f.special_property_1=special_property_value_1 The available operators are: - "=" - equals
- "!=" - not equals
- ">=" or "=gte=" - greater than or equals
- "<=" or "=lte=" - less than or equals
- ">" or "=gt=" - greater than
- "<" or "=lt=" - less than
- "@>" or "=cs=" - contains
- selection
List of properties to be returned in the features result list. Example, 'p.property_name'.
- limit
The maximum number of features in the response (Default is 30000).
- context
The context where the operation will be performed on a composite layer. If not specified, the operation occurs based on the extension rules.
- version
The version of the feature collection
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable error.com.here.platform.data.client.DataClientRetriableExceptionin case of retriable error.java.lang.IllegalArgumentExceptionif the layer does not exist or is not an interactiveMap layer.
-
abstract
def
getFeatureCollectionBySpatialSearchGeometry(layerId: String, geometry: Geometry, radius: Option[Int], searchParam: Set[SearchParam] = Set.empty, selection: Set[String] = Set.empty, limit: Option[Int] = None, context: Option[InteractiveMapContext] = None, version: Option[Long] = None): Future[FeatureCollection]
Returns the features which intersects the provided geometry.
Returns the features which intersects the provided geometry.
- layerId
Layer ID of the queried interactiveMap layer.
- geometry
The geometry which is used as origin for the search.
- radius
Radius in meter which is added as buffer to the geometry.
- searchParam
List of additional feature filters resulting in a subset of features.
Allowed prefixes to be used for property search are:- 'p.' - used to access values stored in 'properties' property of the feature
- 'f.' - used to access values which are added by default in the stored feature, the possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'.
Example - p.property_1=property_value_1 or f.special_property_1=special_property_value_1 The available operators are: - "=" - equals
- "!=" - not equals
- ">=" or "=gte=" - greater than or equals
- "<=" or "=lte=" - less than or equals
- ">" or "=gt=" - greater than
- "<" or "=lt=" - less than
- "@>" or "=cs=" - contains
- selection
List of properties to be returned in the features result list. Example, 'p.property_name'.
- limit
The maximum number of features in the response (Default is 30000).
- context
The context where the operation will be performed on a composite layer. If not specified, the operation occurs based on the extension rules.
- version
The version of the feature collection
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable error.com.here.platform.data.client.DataClientRetriableExceptionin case of retriable error.java.lang.IllegalArgumentExceptionif the layer does not exist or is not an interactiveMap layer.
-
abstract
def
getFeatureCollectionByTile(layerId: String, tileId: String, tileType: TileType, searchParam: Set[SearchParam] = Set.empty, selection: Set[String] = Set.empty, limit: Option[Int] = None, context: Option[InteractiveMapContext] = None, version: Option[Long] = None): Future[FeatureCollection]
Returns the features selected by tile type and tile id of the interactiveMap layer.
Returns the features selected by tile type and tile id of the interactiveMap layer.
- layerId
Layer ID of the queried interactiveMap layer.
- tileId
The tile ID to be queried.
- tileType
The type of tile identifier. Available values are quadkey, web, tms, here.
- searchParam
List of additional feature filters resulting in a subset of features.
Allowed prefixes to be used for property search are:- 'p.' - used to access values stored in 'properties' property of the feature
- 'f.' - used to access values which are added by default in the stored feature, the possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'.
Example - p.property_1=property_value_1 or f.special_property_1=special_property_value_1 The available operators are: - "=" - equals
- "!=" - not equals
- ">=" or "=gte=" - greater than or equals
- "<=" or "=lte=" - less than or equals
- ">" or "=gt=" - greater than
- "<" or "=lt=" - less than
- "@>" or "=cs=" - contains
- selection
List of properties to be returned in the features result list. Example, 'p.property_name'.
- limit
The maximum number of features in the response (Default is 30000).
- context
The context where the operation will be performed on a composite layer. If not specified, the operation occurs based on the extension rules.
- version
The version of the feature collection
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable error.com.here.platform.data.client.DataClientRetriableExceptionin case of retriable error.java.lang.IllegalArgumentExceptionif the layer does not exist or is not an interactiveMap layer.
-
abstract
def
getHexBinsByBbox(layer: String, bbox: BoundingBox, searchParam: Set[SearchParam] = Set.empty, absoluteResolution: Option[Int], relativeResolution: Option[Int], property: Option[String], pointMode: Option[Boolean], singleCoord: Option[Boolean], sampling: Option[SamplingRatio], context: Option[InteractiveMapContext] = None, version: Option[Long] = None): Future[FeatureCollection]
This method returns the HexBins for a given bounding box.
This method returns the HexBins for a given bounding box.
- layer
Layer ID of the queried interactiveMap layer.
- bbox
The bounding box in which the features needs to be searched; for meaning of bbox coordinates see https://developer.here.com/documentation/data-client-library/dev_guide/client/publish-data.html#interactive-layer-coords
- searchParam
List of additional feature filters resulting in a subset of features.
Allowed prefixes to be used for property search are:- 'p.' - used to access values stored in 'properties' property of the feature
- 'f.' - used to access values which are added by default in the stored feature, the possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'.
Example - p.property_1=property_value_1 or f.special_property_1=special_property_value_1 The available operators are: - "=" - equals
- "!=" - not equals
- ">=" or "=gte=" - greater than or equals
- "<=" or "=lte=" - less than or equals
- ">" or "=gt=" - greater than
- "<" or "=lt=" - less than
- "@>" or "=cs=" - contains
- absoluteResolution
The H3 hexagon resolution. Valid values are [0,13].
- relativeResolution
Relative resolution added to the absolute one. Valid values are [-2,2].
- property
A property of the original features for which to calculate statistics.
- pointMode
Returns the centroid of hexagons as GeoJson features. Default is false.
- singleCoord
Force to evaluate the first object coordinate only. Default is false.
- sampling
Sampling ratio of underlying dataset.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable error.com.here.platform.data.client.DataClientRetriableExceptionin case of retriable error.java.lang.IllegalArgumentExceptionif the layer does not exist or is not an interactiveMap layer.
-
abstract
def
getHexBinsByTileId(layerId: String, tileId: String, tileType: TileType, searchParam: Set[SearchParam] = Set.empty, absoluteResolution: Option[Int], relativeResolution: Option[Int], property: Option[String], pointMode: Option[Boolean], singleCoord: Option[Boolean], sampling: Option[SamplingRatio], context: Option[InteractiveMapContext] = None, version: Option[Long] = None): Future[FeatureCollection]
This method returns the HexBins for a given tile.
This method returns the HexBins for a given tile.
- layerId
Layer ID of the queried interactiveMap layer.
- tileId
The tile ID to be queried.
- tileType
The type of tile identifier.
- searchParam
List of additional feature filters resulting in a subset of features.
Allowed prefixes to be used for property search are:- 'p.' - used to access values stored in 'properties' property of the feature
- 'f.' - used to access values which are added by default in the stored feature, the possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'.
Example - p.property_1=property_value_1 or f.special_property_1=special_property_value_1 The available operators are: - "=" - equals
- "!=" - not equals
- ">=" or "=gte=" - greater than or equals
- "<=" or "=lte=" - less than or equals
- ">" or "=gt=" - greater than
- "<" or "=lt=" - less than
- "@>" or "=cs=" - contains
- absoluteResolution
The H3 hexagon resolution. Valid values are [0,13].
- relativeResolution
Relative resolution added to the absolute one. Valid values are [-2,2].
- property
A property of the original features for which to calculate statistics.
- pointMode
Returns the centroid of hexagons as GeoJson features. Default is false.
- singleCoord
Force to evaluate the first object coordinate only. Default is false.
- sampling
Sampling ratio of underlying dataset.
- context
– The context where the operation will be performed on a composite layer. If not specified, the operation occurs based on the extension rules.
- version
The version of the feature collection
- returns
Returns a FeatureCollection that contains the HexBins including estimated/real counts.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable error.com.here.platform.data.client.DataClientRetriableExceptionin case of retriable error.java.lang.IllegalArgumentExceptionif the layer does not exist or is not an interactiveMap layer.
-
abstract
def
getIMLStatistics(layerId: String): Future[Statistics]
Returns the statistics information of the interactiveMap layer.
Returns the statistics information of the interactiveMap layer.
- layerId
Layer ID of the queried interactiveMap layer.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable error.com.here.platform.data.client.DataClientRetriableExceptionin case of retriable error.java.lang.IllegalArgumentExceptionif the layer does not exist or is not an interactiveMap layer.
-
abstract
def
getLatestVersion(startVersion: Option[Long] = None): Future[Option[Long]]
Get latest version available for the given catalog.
Get latest version available for the given catalog.
- startVersion
Previously discovered version. Always specify version if you've ever discovered it before and use None only if you are processing data of this catalog for the first time. If the version specified has been deleted, the lowest existing version is assumed.
- returns
Returns Some(version) - latest version for the given catalog. If the catalog doesn't contain any versions None will be returned.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getLayerVersions(version: Long): Future[LayerVersions]
Get the latest change per layer for a given version.
Get the latest change per layer for a given version.
Returns information about catalog version. It will return an error if the catalog does not have any version, or if the version passed in the query parameter does not exist.
- version
Catalog version.
- returns
the latest change per layer for a given version
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getMinimumVersion(): Future[Option[Long]]
Get minimum version available for the given catalog.
Get minimum version available for the given catalog.
- returns
Returns Some(version) - minimum version for the given catalog. If the catalog doesn't contain any versions None will be returned.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getPartitions(version: Long, layer: String, additionalFields: Set[AdditionalField] = Set.empty, partId: Option[String] = None, context: VersionedLayerContext = VersionedLayerContext.DEFAULT): Future[Source[Partition, NotUsed]]
Get metadata for requested partitions from a specific versioned layer.
Get metadata for requested partitions from a specific versioned layer.
Source returned by this function *MUST BE* consumed. If accidentally left not fully consumed it will be assumed the incoming data should remain back-pressured, and will stall the incoming data via TCP back-pressure mechanisms. Such stall connection can exhaust DataClient connection pool.
- version
Catalog version. This parameter cannot be null.
- layer
Layer id to be used for filtering. If the layer specified in request does not exist, an error is returned.
- additionalFields
If this parameter is set, the fields set during commit of the tile will be included in the response.
- partId
Indicates which part of the layer shall be queried.
- context
The context where the operation will be performed on a composite layer.
- returns
metadata for requested partitions
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getPartitionsAsIterator(version: Long, layer: String, additionalFields: Set[AdditionalField] = Set.empty, partId: Option[String] = None, context: VersionedLayerContext = VersionedLayerContext.DEFAULT): Future[Iterator[Partition]]
Get metadata for requested partitions filtered by versioned layer.
Get metadata for requested partitions filtered by versioned layer. Fetch elements from the iterator may be a blocking call.
Iterator returned by this function *MUST BE* consumed. If accidentally left not fully consumed it will be assumed the incoming data should remain back-pressured, and will stall the incoming data via TCP back-pressure mechanisms. Such stall connection can exhaust DataClient connection pool.
- version
Catalog version. This parameter cannot be null.
- layer
Layer id to be used for filtering. If the layer specified in request does not exist, an error is returned.
- additionalFields
If this parameter is set, the fields set during commit of the tile will be included in the response.
- partId
Indicates which part of the layer shall be queried.
- context
The context where the operation will be performed on a composite layer.
- returns
metadata for requested partitions
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getPartitionsById(version: Long, layer: String, partitions: Seq[String], additionalFields: Set[AdditionalField] = Set.empty, context: VersionedLayerContext = VersionedLayerContext.DEFAULT): Future[Seq[Partition]]
Get metadata for requested partitions of a versioned layer that filtered by layer and partitions.
Get metadata for requested partitions of a versioned layer that filtered by layer and partitions.
- version
Catalog version. This parameter cannot be null.
- layer
Layer id to be used for filtering. If the layer specified in request does not exist, an error is returned.
- partitions
Partition names to be used for filtering. If a partition specified in the request does not exist, it is skipped in the response.
- additionalFields
If this parameter is set, the fields set during commit of the tile will be included in the response.
- context
The context where the operation will be performed on a composite layer.
- returns
metadata for requested partitions
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getPartitionsParts(layer: String, parts: Int): Future[QueryParts]
Returns QueryParts which represent the layer parts that can be used to limit the scope of a query operation This allows to run parallel queries with multiple parts.
Returns QueryParts which represent the layer parts that can be used to limit the scope of a query operation This allows to run parallel queries with multiple parts. The user has to provide the desired number of parts and the service will return a list of Part Ids. Please note in some cases the requested number of parts will make them too small and in this case the service might return lesser amount of the parts than requested.
- layer
Layer ID of the queried index layer
- parts
Indicates requested number of layer parts. User can split the single large query into multiple parts.
- Exceptions thrown
java.lang.IllegalArgumentExceptionif the layer does not exist
-
abstract
def
getQuadBinsByBbox(layer: String, bbox: BoundingBox, searchParam: Set[SearchParam] = Set.empty, relativeResolution: Option[Int], noBuffer: Option[Boolean], countMode: Option[CountMode], context: Option[InteractiveMapContext] = None, version: Option[Long] = None): Future[FeatureCollection]
This method returns the QuadBins for a given bounding box.
This method returns the QuadBins for a given bounding box. It can be used to split Geometry requests in smaller bits to stay below the 50MB payload and 30k feature count limit.
- layer
Layer ID of the queried interactiveMap layer.
- bbox
The bounding box in which the features needs to be searched; for meaning of bbox coordinates see https://developer.here.com/documentation/data-client-library/dev_guide/client/publish-data.html#interactive-layer-coords
- searchParam
List of additional feature filters resulting in a subset of features.
Allowed prefixes to be used for property search are:- 'p.' - used to access values stored in 'properties' property of the feature
- 'f.' - used to access values which are added by default in the stored feature, the possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'.
Example - p.property_1=property_value_1 or f.special_property_1=special_property_value_1 The available operators are: - "=" - equals
- "!=" - not equals
- ">=" or "=gte=" - greater than or equals
- "<=" or "=lte=" - less than or equals
- ">" or "=gt=" - greater than
- "<" or "=lt=" - less than
- "@>" or "=cs=" - contains
- relativeResolution
The resolution of the QuadBins. Valid values are [0, 4].
- noBuffer
Do not place a buffer around QuadBins.
- countMode
The count mode for the QuadBins.
- version
The version of the feature collection
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable error.com.here.platform.data.client.DataClientRetriableExceptionin case of retriable error.java.lang.IllegalArgumentExceptionif the layer does not exist or is not an interactiveMap layer.
-
abstract
def
getQuadBinsByTileId(layerId: String, tileId: String, tileType: TileType, searchParam: Set[SearchParam] = Set.empty, relativeResolution: Option[Int], noBuffer: Option[Boolean], countMode: Option[CountMode], context: Option[InteractiveMapContext] = None, version: Option[Long] = None): Future[FeatureCollection]
This method returns the QuadBins for a given tile.
This method returns the QuadBins for a given tile. It can be used to split Geometry requests in smaller bits to stay below the 50MB payload and 30k feature count limit.
- layerId
Layer ID of the queried interactiveMap layer.
- tileId
The tile ID to be queried.
- tileType
The type of tile identifier.
- searchParam
List of additional feature filters resulting in a subset of features.
Allowed prefixes to be used for property search are:- 'p.' - used to access values stored in 'properties' property of the feature
- 'f.' - used to access values which are added by default in the stored feature, the possible values are: 'f.id', 'f.createdAt' and 'f.updatedAt'.
Example - p.property_1=property_value_1 or f.special_property_1=special_property_value_1 The available operators are: - "=" - equals
- "!=" - not equals
- ">=" or "=gte=" - greater than or equals
- "<=" or "=lte=" - less than or equals
- ">" or "=gt=" - greater than
- "<" or "=lt=" - less than
- "@>" or "=cs=" - contains
- relativeResolution
The resolution of the QuadBins. Valid values are [0, 4].
- noBuffer
Do not place a buffer around QuadBins.
- countMode
The count mode for the QuadBins.
- context
– The context where the operation will be performed on a composite layer. If not specified, the operation occurs based on the extension rules.
- version
The version of the feature collection
- returns
Returns a FeatureCollection that contains the QuadBins including estimated/real counts.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable error.com.here.platform.data.client.DataClientRetriableExceptionin case of retriable error.java.lang.IllegalArgumentExceptionif the layer does not exist or is not an interactiveMap layer.
-
abstract
def
getTilesContainingFeatures(layer: String, startingTiles: Seq[Tile], targetZoomLevel: Int, parallelization: Int = 1, context: Option[InteractiveMapContext] = None): Future[Source[Seq[Tile], NotUsed]]
This method returns all tiles containing features on target level
This method returns all tiles containing features on target level
- layer
Layer ID of the queried interactiveMap layer.
- startingTiles
The high level tiles to iterate. The only supported tile type is quadkey. If it is empty, all tiles within web mercator bounds (latitude between -85.05° and +85.05°) will be retrieved.
- targetZoomLevel
The target level of tiles to return.
- parallelization
Maximum number of parallel calls to underlying service.
- context
The context where the operation will be performed on a composite layer. If not specified, the operation occurs based on the extension rules.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable error.com.here.platform.data.client.DataClientRetriableExceptionin case of retriable error.java.lang.IllegalArgumentExceptionif targetZoomLevel has incorrect value or if any of startingTiles has incorrect level
-
abstract
def
getVersion(version: Long): Future[VersionInfo]
Get version information for given catalog version
Get version information for given catalog version
To fetch version information for specified catalog version (i.e. for initial catalog version pass 0L).
- version
version. Must be greater than or equal to zero. This parameter cannot be null.
- returns
version information
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getVersions(startVersion: Long, endVersion: Long): Future[Seq[VersionInfo]]
Get version information for given catalog version range
Get version information for given catalog version range
1000 is maximum number of versions which can be returned per one call. The versions are returned in ascending order (oldest versions first).
To fetch version information for initial catalog version (i.e. version 0) pass startVersion -1L.
- startVersion
Start version (exclusive). If the version specified has been deleted, the lowest existing version is assumed. This parameter cannot be null.
- endVersion
End version (inclusive). Must be greater than
startVersion.- returns
version information for given catalog version range
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getVolatilePartitions(layer: String, filter: VolatilePartitionsFilter = VolatilePartitionsFilter.empty, additionalFields: Set[AdditionalField] = Set.empty): Future[Source[Partition, NotUsed]]
Get metadata for partitions of a volatile layer that satisfied layer's and filter's condition.
Get metadata for partitions of a volatile layer that satisfied layer's and filter's condition.
Source returned by this function *MUST BE* consumed. If accidentally left not fully consumed it will be assumed the incoming data should remain back-pressured, and will stall the incoming data via TCP back-pressure mechanisms. Such stall connection can exhaust DataClient connection pool.
- layer
Layer id to be used for filtering. If the layer specified in request does not exist, an error is returned.
- filter
Volatile partitions filter which uses for fetch only needed partitions
- additionalFields
If this parameter is set, the fields set during commit of the tile will be included in the response. metadata for partitions changed between versions
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getVolatilePartitionsAsIterator(layer: String, filter: VolatilePartitionsFilter = VolatilePartitionsFilter.empty, additionalFields: Set[AdditionalField] = Set.empty): Future[Iterator[Partition]]
Get metadata for partitions of a volatile layer that satisfied layer's and filter's condition.
Get metadata for partitions of a volatile layer that satisfied layer's and filter's condition. Fetch elements from the iterator may be a blocking call.
Iterator returned by this function *MUST BE* consumed. If accidentally left not fully consumed it will be assumed the incoming data should remain back-pressured, and will stall the incoming data via TCP back-pressure mechanisms. Such stall connection can exhaust DataClient connection pool.
- layer
Layer id to be used for filtering. If the layer specified in request does not exist, an error is returned.
- filter
Volatile partitions filter which uses for fetch only needed partitions
- additionalFields
If this parameter is set, the fields set during commit of the tile will be included in the response. metadata for partitions changed between versions
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
queryIndex(layer: String, queryString: Option[String], partId: Option[String] = None): Future[Source[IndexPartition, NotUsed]]
Retrieve all the IndexPartitions when query is not provided, otherwise only the IndexPartitions which satisfy the provided query written in the RSQL query language.
Retrieve all the IndexPartitions when query is not provided, otherwise only the IndexPartitions which satisfy the provided query written in the RSQL query language.
- layer
Layer ID of the queried index layer
- queryString
String written in the RSQL query language to query the index layer
- partId
Indicates which part of the layer shall be queried.
- Exceptions thrown
java.lang.IllegalArgumentExceptionif the layer does not exist
-
abstract
def
queryIndexAsIterator(layer: String, queryString: Option[String], partId: Option[String] = None): Future[Iterator[IndexPartition]]
Retrieve all the IndexPartitions when query is not provided, otherwise only the IndexPartitions which satisfy the provided query written in the RSQL query language.
Retrieve all the IndexPartitions when query is not provided, otherwise only the IndexPartitions which satisfy the provided query written in the RSQL query language.
Example:
val partitions: Iterator[IndexPartition] = queryApi.queryIndexAsIterator(layer, "key1!=abc;key2<42,key3==true")
- layer
Layer ID of the queried index layer
- queryString
String written in the RSQL query language to query the index layer
- partId
Indicates which part of the layer shall be queried.
- Exceptions thrown
java.lang.IllegalArgumentExceptionif the layer does not exist
-
abstract
def
queryIndexDeleteStatus(layer: String, deleteId: String): Future[DeleteIndexesStatusResponse]
Retrieve the status of the index layer content delete request.
Retrieve the status of the index layer content delete request.
- layer
Layer ID of the queried index layer
- deleteId
Delete request ID
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable errorjava.lang.IllegalArgumentExceptionif the layer does not exist
-
abstract
def
queryIndexParts(layer: String, parts: Int): Future[IndexParts]
Returns IndexParts which represent the layer parts that can be used to limit the scope of a query operation This allows to run parallel queries with multiple parts.
Returns IndexParts which represent the layer parts that can be used to limit the scope of a query operation This allows to run parallel queries with multiple parts. The user has to provide the desired number of parts and the service will return a list of Part Ids. Please note in some cases the requested number of parts will make them too small and in this case the service might return lesser amount of the parts than requested.
- layer
Layer ID of the queried index layer
- parts
Indicates requested number of layer parts. User can split the single large query into multiple parts.
- Exceptions thrown
java.lang.IllegalArgumentExceptionif the layer does not exist
-
abstract
def
subscribe(layer: String, consumerSettings: ConsumerSettings, f: (Partition) ⇒ Unit): Future[SubscriptionControl]
Get metadata for partitions of a stream layer.
Get metadata for partitions of a stream layer.
If the function
fthrows an exception the stream will be completed with failure. The functionfis always invoked on the elements in the order they arrive.- layer
Layer id to be used for subscription. If the layer specified does not exist or not a stream layer, an error is returned.
- consumerSettings
consumer settings
- f
function which will be executed for each partition
- returns
control object, to be able to stop subscription
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
subscribe(layer: String, consumerSettings: ConsumerSettings): Future[Subscription]
Get metadata for partitions of a stream layer.
Get metadata for partitions of a stream layer.
- layer
Layer id to be used for subscription. If the layer specified in request does not exist or not a stream layer, an error is returned.
- consumerSettings
consumer settings
- returns
metadata for partitions published to stream layer
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
subscribeToNotifications(consumerSettings: NotificationConsumerSettings, f: (BatchPublicationNotification) ⇒ Unit): Future[NotificationSubscriptionControl]
Subscribe to catalog notifications.
Subscribe to catalog notifications. The catalog must have notificationsEnabled to support it.
- consumerSettings
consumer settings
- f
function which will be executed for each notification
- returns
control object, to be able to stop subscription
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
subscribeToNotifications(consumerSettings: NotificationConsumerSettings): Future[NotificationSubscription]
Subscribe to catalog notifications.
Subscribe to catalog notifications. The catalog must have notificationsEnabled to support it.
- consumerSettings
consumer settings
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()