Area scheme and subsets

Data in a catalog can be made available in data subsets defined as restrictions on the total data available. If you want to apply some area or layer restrictions you need to configure it at point of creation of the layer(s). Some settings you can update later. For the details, see Configure Catalogs.

There are two types of data subsets:

• areas - define area restrictions
• layers - define layer restrictions

You can control the data subset restrictions per versioned and volatile layer. For that you should pass these new optional parameters when defining the layerType of a layer as

• VersionedLayerType(secureHandles: Option[Boolean] = None, subsetRestrictions: Option[Boolean] = None) or
• VolatileLayerType(secureHandles: Option[Boolean] = None, subsetRestrictions: Option[Boolean] = None).

secureHandles indicates if the layer metadata and blob are in a mode that secure dataHandles support. It supports only heretile layer partitioning. The produced dataHandles contain a reference partitionId and a secure signature, for example '24235893475945c961-e74d-478f-8afe-da53cf4189e3EAAQuWgWdiwktzMKEeweZA-6HteHy38hXR_NY-qpeSamlJc'. subsetRestrictions is deprecated on the catalog level. Use subsetRestrictions on the layer level only. Indicates if the subsetRestrictions for a layer is enabled or not. Supported only for layers with heretile partitioning. After deprecation setting subsetRestrictions on the catalog level takes no effect. It will simply be ignored. areaScheme is deprecated on the catalog level. Use DataSubsetsApi to set areaScheme in the data subset instead. HERE Resource Name (HRN) of the Area Scheme used in the data subset. After deprecation setting areaScheme on the catalog level takes no effect. It will simply be ignored.

Only two area schemes are supported for areas data subsets 'hrn:here:areascheme::olp-here:default-countries' and 'hrn:here:areascheme::olp-here:map-components'.

There are functions of DataSubsetsApi to create, retrieve, delete data subsets, or data subsets fingerprint:

• createDataSubsets: Create data subsets
• getDataSubsets: Get the list of all accessible data subsets which match the optional areaId or layerId filter
• getDataSubsetsAsSource: Get the list of all accessible data subsets which match the optional areaId or layerId filter as a Pekko Source
• getSubset: Get the details of a data subset
• deleteDataSubset: Delete a data subset
• getDataSubsetsFingerprint: Get a fingerprint that represents the accessible data subsets configuration