Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ConfigApi

Index

Interfaces

Type Aliases

Functions

Type Aliases

BillingTags

BillingTags: string[]

List of billing tags a free-form tag which is used for grouping billing records together. If supplied, it must be between 4 - 16 characters, contain only alphanumeric ASCII characters [A-Za-z0-9].

CRC

CRC: "CRC-32C"

The CRC algorithm used to calculate the checksum for the partitions in this layers

ContentEncoding

ContentEncoding: "gzip"

Identifies whether the data is compressed.

ContentType

ContentType: string

The MIME type of the data is stored in this layer.

DataRedundancyEnum

DataRedundancyEnum: "single-instance" | "multi-instance"

DeprecatedPartitioningScheme

DeprecatedPartitioningScheme: "generic" | "heretile"

The name of the partitioning scheme for the layer.

Digest

Digest: "MD5" | "SHA-1" | "SHA-256"

The digest algorithm used to calculate the checksum for the partitions in this layer. If specified, you can assume that all partitions in the layer, at every version, were calculated using this algorithm. Note that it is the responsibility of the data publisher to use this algorithm to calculate partition checksums. The HERE platform does not verify that the specified algorithm was actually used.

IdEnum

IdEnum: "eu-ireland" | "us-oregon"

IndexLayerType

IndexLayerType: "index"

The type of data availability that this layer provides.

InteractiveMapsLayerType

InteractiveMapsLayerType: "interactivemap"

The type of data availability that this layer provides

LayerCreated

LayerCreated: string

The layer creation timestamp.

LayerDescription

LayerDescription: string

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

LayerHrn

LayerHrn: string

The HERE Resource Name (HRN) of the layer.

LayerId

LayerId: string

The ID to use when referring to this layer programmatically.

LayerName

LayerName: string

The display name for the layer.

LayerSummary

LayerSummary: string

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

MaxMemoryPolicyEnum

MaxMemoryPolicyEnum: "failOnWrite" | "replaceLessRecentlyUsedKey"

ObjectstoreLayerType

ObjectstoreLayerType: "objectstore"

The type of data availability that this layer provides

PartitioningScheme

PartitioningScheme: "generic" | "heretile"

The name of the partitioning scheme for the layer.

RoleEnum

RoleEnum: "primary" | "secondary"

StreamLayerType

StreamLayerType: "stream"

The type of data availability that this layer provides.

Tags

Tags: string[]

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

Ttl

Ttl: number

The expiry time in milliseconds for data in this layer. Data is automatically removed after the specified time limit has elapsed. For volatile layers the TTL value must be between 60000 (1 minute) and 604800000 (7 days). For stream layers the TTL value must be between 600000 (10 minutes) and 259200000 (72 hours).

TtlEnum

TtlEnum: "7.days" | "15.days" | "1.month" | "2.months" | "3.months" | "4.months" | "6.months" | "1.year" | "1.5.years" | "2.year" | "unlimited"

TtlHours

TtlHours: number

The expiry time in hours for data in this layer. Data is automatically removed after the specified time limit has elapsed.

TypeEnum

TypeEnum: "bool" | "int" | "string" | "heretile" | "timewindow"

VersionedLayerType

VersionedLayerType: "versioned"

The type of data availability that this layer provides.

VolatileLayerType

VolatileLayerType: "volatile"

The type of data availability that this layer provides.

ZoomLevelEnum

ZoomLevelEnum: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "14"

Functions

catalogExists

  • catalogExists(builder: RequestBuilder, params: { billingTag?: string; catalogHrn: string }): Promise<Response>

createCatalog

deleteCatalog

deleteLayer

disableAutomaticVersionDeletion

getCatalog

  • getCatalog(builder: RequestBuilder, params: { billingTag?: string; catalogHrn: string }): Promise<Catalog>

  • Gets the full catalog configuration for the requested catalog. The catalog configuration contains descriptive and structural information such as layer definitions and layer types.

    summary

    Gets the details of a catalog

    Parameters

    • builder: RequestBuilder
    • params: { billingTag?: string; catalogHrn: string }
      • Optional billingTag?: string
      • catalogHrn: string

    Returns Promise<Catalog>

getCatalogStatus

  • Takes the randomly generated token that you receive when you submit a catalog for creation. You can use it to monitor the status of your request.

    summary

    Gets the status of a create, update or delete catalog request.

    Parameters

    • builder: RequestBuilder
    • params: { billingTag?: string; token: string }
      • Optional billingTag?: string
      • token: string

    Returns Promise<CatalogSuccessStatus>

getCatalogs

  • getCatalogs(builder: RequestBuilder, params: { access?: string[]; billingTag?: string; coverage?: string[]; layerType?: string[]; limit?: number; linkable?: boolean; marketplaceReady?: boolean; organisation?: string; organisationType?: string[]; q?: string; region?: string[]; resourceType?: string; schemaHrn?: string; sortBy?: string; sortOrder?: string; verbose?: string }): Promise<CatalogsListResult>

  • Lists all catalogs that your account has access to. To get access to a catalog, your administrator must associate this catalog in your HERE platform account. By default, the list provides summary data for each catalog such as the title, the configuration URL, and the resource type.

    summary

    Gets a list of all catalogs

    Parameters

    • builder: RequestBuilder
    • params: { access?: string[]; billingTag?: string; coverage?: string[]; layerType?: string[]; limit?: number; linkable?: boolean; marketplaceReady?: boolean; organisation?: string; organisationType?: string[]; q?: string; region?: string[]; resourceType?: string; schemaHrn?: string; sortBy?: string; sortOrder?: string; verbose?: string }
      • Optional access?: string[]
      • Optional billingTag?: string
      • Optional coverage?: string[]
      • Optional layerType?: string[]
      • Optional limit?: number
      • Optional linkable?: boolean
      • Optional marketplaceReady?: boolean
      • Optional organisation?: string
      • Optional organisationType?: string[]
      • Optional q?: string
      • Optional region?: string[]
      • Optional resourceType?: string
      • Optional schemaHrn?: string
      • Optional sortBy?: string
      • Optional sortOrder?: string
      • Optional verbose?: string

    Returns Promise<CatalogsListResult>

patchCatalog

  • Modify some fields of the catalog. The existing HTTP PUT method only allows a complete replacement of a catalog configuration, HTTP PATCH method is used to modify some fields of existing catalog configuration. All fields are optional. Specify field value to modify it, not specified fields are ignored. To remove the field value use the null value. For more information, see RFC 7396 - JSON Merge Patch.

    summary

    Modify a catalog

    Parameters

    Returns Promise<StatusLink>

patchLayer

  • Modify some fields of the catalog layer. HTTP PATCH method is used to modify some fields of existing layer configuration. All fields are optional. Specify field value to modify it, not specified fields are ignored. To remove the field value use the null value. For more information see RFC 7396 - JSON Merge Patch.

    summary

    Modify a catalog layer

    Parameters

    Returns Promise<StatusLink>

updateCatalog

Generated using TypeDoc