DesiredCatalog (API Reference)
Class DesiredCatalog
This class provides an interface to the user, to identify a catalog on the HERE platform, whose data he wants to access.
The user can specify the HERE Resource Name (HRN) for the catalog along with a hint for the desired version.
If the desired version is not available, the HERE platform will determine the best version to use for a specific catalog or result in error logs.
For information on how to specify the catalog version, see CatalogVersionHint.
For information about catalogs and related concepts see CatalogIdentifier.
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe identifier for the catalog to be accessed on the HERE platform. -
Constructor Summary
ConstructorsConstructorDescriptionDesiredCatalog(String hrn, CatalogVersionHint version) Creates a new instance. -
Method Summary
-
Field Details
-
id
The identifier for the catalog to be accessed on the HERE platform. See
CatalogIdentifier.
-
-
Constructor Details
-
DesiredCatalog
Creates a new instance.
- Parameters:
hrn-A HERE Resource Name (HRN) for this catalog. This is a unique string returned by the HERE platform when you add a new catalog to your project. For more information, see
CatalogIdentifier.hrnversion-The version to use for this Catalog's data. You should use either
CatalogVersionHint.specific(long)to specify a specific version of the catalog orCatalogVersionHint.latest(boolean)to access the latest version of the catalog available on the HERE platform. Based on the value in this field, the HERE platform will determine the best version to use for this catalog or result in error logs if the desired version is not available.
-
-
Method Details