here.platform.models module

HERE platform catalog abstraction.

class here.platform.models.AutomaticVersionDeletion(json_dict: Dict[str, Any])
Bases: JsonDictDocument

Specifies the number of versions to keep for the catalog.

property number_of_versions_to_keep: int
The number of versions to keep.

class here.platform.models.Coverage(json_dict: Dict[str, Any])
Bases: JsonDictDocument

The geographic area that this catalog or layer covers

property admin_areas: List[str]
A list of ISO 3166 two-letter codes for countries and regions

class here.platform.models.Creator(json_dict: Dict[str, Any])
Bases: JsonDictDocument

Details of the user or the application that initially created the catalog.

property id: str
The unique ID of the user or application that initially created the catalog

class here.platform.models.DurableVolume(volume: Dict[str, Any])
Bases: Volume

Describes a catalog durable volume to be used for storing the layer’s data content

property volume_type: VolumeType
The type of volume used for storing the layer’s data content

class here.platform.models.MaxMemoryPolicy(value)
Bases: Enum

Enum for the keys eviction policy when the memory limit for volatile layer is reached.

FAIL_ON_WRITE = 'failOnWrite'

REPLACE_LESS_RECENTLY_USED_KEY = 'replaceLessRecentlyUsedKey'

class here.platform.models.Notifications(json_dict: Dict[str, Any])
Bases: JsonDictDocument

Indicates whether or not to notify each time the version of the catalog changes

property enabled: bool
Determines if the notifications are enabled for the catalog

class here.platform.models.Organisation(json_dict: Dict[str, Any])
Bases: JsonDictDocument

Organisation of the customer that created the catalog.

property id: str
The ID of the customer organisation relating to this catalog

class here.platform.models.Owner(json_dict: Dict[str, Any])
Bases: JsonDictDocument

Details of the owner of the catalog.

property creator: Creator
The user or application that initially created the catalog

property organisation: Organisation
The organisation of the customer that created the catalog

class here.platform.models.Partitioning(json_dict: Dict[str, Any])
Bases: JsonDictDocument

Describes the way in which data is partitioned within the layer

property scheme: PartitioningScheme
The name of the partitioning scheme for the layer

property tile_levels: int | None
Quadtree tile levels which contain data partitions.

class here.platform.models.PartitioningScheme(value)
Bases: Enum

Enum class for the name of the partitioning scheme for the layer.

GENERIC = 'generic'

HERE_TILE = 'heretile'

NO_PARTITIONING = 'nopartitioning'

class here.platform.models.Region(json_dict: Dict[str, Any])
Bases: JsonDictDocument

The replication region of the catalog, including each region’s role

property id: str
The ID of the region

property role: str
Indicates whether the region is a primary or failover region

class here.platform.models.Replication(json_dict: Dict[str, Any])
Bases: JsonDictDocument

The replication set for the catalog.

property regions: List[Region]
A list of the catalog’s replication regions and each region’s role

class here.platform.models.VolatileVolume(volume: Dict[str, Any])
Bases: Volume

Describes a catalog volatile volume to be used for storing the layer’s data content.

property max_memory_policy: MaxMemoryPolicy
Defines a keys eviction policy when the memory limit for volatile layer is reached

property volume_type: VolumeType
The type of volume used for storing the layer’s data content

class here.platform.models.Volume(volume_type: str, max_memory_policy: str | None = None)
Bases: JsonDictDocument

Describes the volume to be used for storing the layer’s data content

class here.platform.models.VolumeType(value)
Bases: Enum

Enum class for the volume type to be used for storing the layer’s data content..

DURABLE = 'durable'

VOLATILE = 'volatile'