trait FlinkQueryApi extends AnyRef
- Alphabetic
- By Inheritance
- FlinkQueryApi
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def getChanges(startVersion: Long, endVersion: Long, layer: String, additionalFields: Set[AdditionalField] = Set.empty, context: VersionedLayerContext = VersionedLayerContext.DEFAULT): SourceFunction[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 included in the response with an empty
dataHandlevalue. For example, if you request versions 0 to 10, and a partition was created in version 3 then deleted in version 7, it is included in the response with an emptydataHandlevalue.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.
- context
The context where the operation will be performed on a composite layer. 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 getChangesAsIterator(startVersion: Long, endVersion: Long, layer: String, additionalFields: Set[AdditionalField] = Set.empty, context: VersionedLayerContext = VersionedLayerContext.DEFAULT): 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 included in the response with an empty
dataHandlevalue. For example, if you request versions 0 to 10, and a partition was created in version 3 then deleted in version 7, it is included in the response with an emptydataHandlevalue.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.
- context
The context where the operation will be performed on a composite layer. 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 getChangesAsStream(startVersion: Long, endVersion: Long, layer: String, additionalFields: Set[AdditionalField] = Set.empty, parts: Option[Int] = None, context: VersionedLayerContext = VersionedLayerContext.DEFAULT)(implicit env: StreamExecutionEnvironment): DataStream[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 included in the response with an empty
dataHandlevalue. For example, if you request versions 0 to 10, and a partition was created in version 3 then deleted in version 7, it is included in the response with an emptydataHandlevalue.DataStream 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
- parts
Indicates requested number of layer parts. User can split the single large query into multiple parts.
- 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): 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 included in the response with an empty
dataHandlevalue. For example, if you request versions 0 to 10, and a partition was created in version 3 then deleted in version 7, it is included in the response with an emptydataHandlevalue.- 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 getCompatibleVersionsAsIterator(dependencies: Set[CatalogVersion]): 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 versionsjava.lang.InterruptedExceptionIf the current thread was interrupted while waiting for a result
- abstract def getConfiguration(): 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 getFeatureCollectionByBbox(layer: String, bbox: BoundingBox, searchParam: Set[SearchParam] = Set.empty, selection: Set[String] = Set.empty, limit: Option[Int] = None): 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.
- 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
- 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)
- 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 getFeatureCollectionByIds(layer: String, ids: Seq[String], selection: Set[String] = Set.empty): 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'
- 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(layer: String, pageToken: Option[String] = None, selection: Set[String] = Set.empty, limit: Option[Int] = None): 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.
- layer
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)
- 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 getFeatureCollectionBySearchParam(layer: String, searchParam: Set[SearchParam], selection: Set[String] = Set.empty, limit: Option[Int] = None): FeatureCollection
Returns the features by search params from the interactiveMap layer.
Returns the features by search params from the interactiveMap layer.
- layer
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)
- 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 getFeatureCollectionBySpatialSearchCircle(layer: String, latitude: Double, longitude: Double, radius: Int, searchParam: Set[SearchParam] = Set.empty, selection: Set[String] = Set.empty, limit: Option[Int] = None): 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.
- layer
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)
- 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 getFeatureCollectionBySpatialSearchFeature(layer: String, refCatalogHrn: String, refLayerId: String, refFeatureId: String, radius: Option[Int], searchParam: Set[SearchParam] = Set.empty, selection: Set[String] = Set.empty, limit: Option[Int] = None): FeatureCollection
Returns the features which intersects the specified reference feature's geometry.
Returns the features which intersects the specified reference feature's geometry.
- layer
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)
- 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 getFeatureCollectionBySpatialSearchGeometry(layer: String, geometry: Geometry, radius: Option[Int], searchParam: Set[SearchParam] = Set.empty, selection: Set[String] = Set.empty, limit: Option[Int] = None): FeatureCollection
Returns the features which intersects the provided geometry.
Returns the features which intersects the provided geometry.
- layer
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)
- 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 getFeatureCollectionByTile(layer: String, tileId: String, tileType: TileType, searchParam: Set[SearchParam] = Set.empty, selection: Set[String] = Set.empty, limit: Option[Int] = None): 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.
- layer
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)
- 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 getIMLStatistics(layerId: String): 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 errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable errorjava.lang.IllegalArgumentExceptionif the layer does not exist
- abstract def getLatestVersion(startVersion: Option[Long] = None): 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): 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(): 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, context: VersionedLayerContext = VersionedLayerContext.DEFAULT): SourceFunction[Partition]
Get metadata for requested partitions filtered by layer.
Get metadata for requested partitions filtered by 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.
- 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, context: VersionedLayerContext = VersionedLayerContext.DEFAULT): Iterator[Partition]
Get metadata for requested partitions filtered by layer.
Get metadata for requested partitions filtered by 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.
- 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 getPartitionsAsStream(version: Long, layer: String, additionalFields: Set[AdditionalField] = Set.empty, parts: Option[Int] = None, context: VersionedLayerContext = VersionedLayerContext.DEFAULT)(implicit env: StreamExecutionEnvironment): DataStream[Partition]
Get metadata for requested partitions filtered by layer.
Get metadata for requested partitions filtered by layer.
DataStream 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.
- parts
Indicates requested number of layer parts. User can split the single large query into multiple parts.
- 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): Seq[Partition]
Get metadata for requested partitions filtered by layer and partitions.
Get metadata for requested partitions 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 getVersion(version: Long): 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): 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): SourceFunction[Partition]
Get metadata for volatile partitions that satisfied layer's and filter's condition.
Get metadata for volatile partitions 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): Iterator[Partition]
Get metadata for volatile partitions that satisfied layer's and filter's condition.
Get metadata for volatile partitions 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] = None, partId: Option[String] = None): SourceFunction[IndexPartition]
Retrieve all the com.here.platform.data.client.scaladsl.IndexPartitions when query is not provided, otherwise only the com.here.platform.data.client.scaladsl.IndexPartitions which satisfy the provided query written in the RSQL query language.
Retrieve all the com.here.platform.data.client.scaladsl.IndexPartitions when query is not provided, otherwise only the com.here.platform.data.client.scaladsl.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
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 queryIndexAsIterator(layer: String, queryString: Option[String]): Iterator[IndexPartition]
Retrieve all com.here.platform.data.client.scaladsl.IndexPartitions the when the query is not provided, otherwise only the com.here.platform.data.client.scaladsl.IndexPartitions which satisfy the provided query written in the RSQL query language.
Retrieve all com.here.platform.data.client.scaladsl.IndexPartitions the when the query is not provided, otherwise only the com.here.platform.data.client.scaladsl.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
- Exceptions thrown
java.lang.IllegalArgumentExceptionif the layer does not exist
- abstract def queryIndexAsStream(layer: String, queryString: Option[String], parts: Option[Int] = None)(implicit env: StreamExecutionEnvironment): DataStream[IndexPartition]
Retrieve all the com.here.platform.data.client.scaladsl.IndexPartitions when no query is provided, otherwise only the com.here.platform.data.client.scaladsl.IndexPartitions which satisfy the provided query written in the RSQL query language.
Retrieve all the com.here.platform.data.client.scaladsl.IndexPartitions when no query is provided, otherwise only the com.here.platform.data.client.scaladsl.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
- parts
Indicates requested number of layer parts. User can split the single large query into multiple parts.
- 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 queryIndexDeleteStatus(layer: String, deleteId: String): 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): IndexParts
Returns com.here.platform.data.client.scaladsl.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 com.here.platform.data.client.scaladsl.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): SourceFunction[Partition]
Get metadata for partitions of stream layer.
Get metadata for partitions of 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): SourceFunction[BatchPublicationNotification]
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(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @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
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)