Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes the catalog properties.

Hierarchy

  • Catalog

Index

Properties

automaticVersionDeletion?: AutomaticVersionDeletion
billingTags?: BillingTags

Aggregated list of all layersbilling tags. Note that this element is read-only and does not exist inCreateCatalog`. If posted during catalog creation, the value will be ignored.

coverage?: Coverage
created: string

The creation date and time.

description: string

A detailed description of the catalog and what it contains. This information appears on the 'Overview' tab when you open a catalog in the platform portal.

hrn: string

The HERE Resource Name (HRN) of the catalog

id: string

The ID to use when referring to this catalog programmatically. Catalog IDs must be unique across all catalogs in the Open Location Platform. Do not put private information in the catalog ID. The catalog ID forms a portion of the catalog's HERE Resource Name (HRN), and HRNs are visible to other users.

The layers in the catalog.

marketplaceReady?: boolean

Indicates whether the catalog is ready to be listed in the Marketplace. If the value is true, the catalog is ready to be listed in the Marketplace.

name: string

The short name for the catalog

notifications?: Notifications
owner?: Owner
replication: Replication
summary: string

A one-sentence summary of the catalog. You can see this summary when you browse a list of catalogs on the platform portal.

tags: string[]

Some keywords that help to find the catalog when searching in the platform portal

version: number

The version of the catalog configuration. Every change in this number indicates a change in the catalog configuration. It is incremented every time you make changes, such as change catalog parameters or add layers. Note that this is not a metadata/data version as configuration and metadata versions are independent of each other and indicate different kind of changes.

Generated using TypeDoc