ConfigApi

Index

Interfaces

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.

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

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>

- Defined in @here/olp-sdk-dataservice-api/lib/config-api.ts:1034

Checks whether a catalog with the specified HRN exists.

summary
Checks the existence of a catalog

Parameters
- builder: RequestBuilder
- params: {billingTag?: string; catalogHrn: string}
 - Optional billingTag?: string
 - catalogHrn: string
Returns Promise<Response>

createCatalog

createCatalog(builder: RequestBuilder, params: {billingTag?: string; body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-configapi-createcatalog" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">CreateCatalog</a>}): Promise<StatusLink>

- Defined in @here/olp-sdk-dataservice-api/lib/config-api.ts:1066

Creates a new catalog with the specified layers. The create catalog operation runs asynchronously. Once you've submitted the catalog for creation, you'll receive a randomly generated token that you can use to monitor the status of the operation.

summary
Creates a catalog

Parameters
- builder: RequestBuilder
- params: {billingTag?: string; body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-configapi-createcatalog" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">CreateCatalog</a>}
 - Optional billingTag?: string
 - body: CreateCatalog
Returns Promise<StatusLink>

deleteCatalog

deleteCatalog(builder: RequestBuilder, params: {billingTag?: string; catalogHrn: string}): Promise<StatusLink>

- Defined in @here/olp-sdk-dataservice-api/lib/config-api.ts:1097

Deletes a catalog and any layers within that catalog.

summary
Deletes a catalog

Parameters
- builder: RequestBuilder
- params: {billingTag?: string; catalogHrn: string}
 - Optional billingTag?: string
 - catalogHrn: string
Returns Promise<StatusLink>

deleteLayer

deleteLayer(builder: RequestBuilder, params: {catalogHrn: string; layerId: string}): Promise<StatusLink>

- Defined in @here/olp-sdk-dataservice-api/lib/config-api.ts:1125

Deletes a layer of the catalog if it's of layerType 'index', 'volatile', or 'stream'. Other layerTypes are currently not supported.

summary
Delete a layer

Parameters
- builder: RequestBuilder
- params: {catalogHrn: string; layerId: string}
 - catalogHrn: string
 - layerId: string
Returns Promise<StatusLink>

disableAutomaticVersionDeletion

disableAutomaticVersionDeletion(builder: RequestBuilder, params: {catalogHrn: string}): Promise<StatusLink>

- Defined in @here/olp-sdk-dataservice-api/lib/config-api.ts:1150

Disable automatic retired versions cleanup.

summary
Disable automatic version deletion

Parameters
- builder: RequestBuilder
- params: {catalogHrn: string}
 - catalogHrn: string
Returns Promise<StatusLink>

getCatalog

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

- Defined in @here/olp-sdk-dataservice-api/lib/config-api.ts:1180

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

getCatalogStatus(builder: RequestBuilder, params: {billingTag?: string; token: string}): Promise<CatalogSuccessStatus>

- Defined in @here/olp-sdk-dataservice-api/lib/config-api.ts:1211

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>

- Defined in @here/olp-sdk-dataservice-api/lib/config-api.ts:1288

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

patchCatalog(builder: RequestBuilder, params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-configapi-patchcatalog" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">PatchCatalog</a>; catalogHrn: string}): Promise<StatusLink>

- Defined in @here/olp-sdk-dataservice-api/lib/config-api.ts:1348

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
- builder: RequestBuilder
- params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-configapi-patchcatalog" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">PatchCatalog</a>; catalogHrn: string}
 - body: PatchCatalog
 - catalogHrn: string
Returns Promise<StatusLink>

patchLayer

patchLayer(builder: RequestBuilder, params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-configapi-patchlayer" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">PatchLayer</a>; catalogHrn: string; layerId: string}): Promise<StatusLink>

- Defined in @here/olp-sdk-dataservice-api/lib/config-api.ts:1382

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
- builder: RequestBuilder
- params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-configapi-patchlayer" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">PatchLayer</a>; catalogHrn: string; layerId: string}
 - body: PatchLayer
 - catalogHrn: string
 - layerId: string
Returns Promise<StatusLink>

updateCatalog

updateCatalog(builder: RequestBuilder, params: {billingTag?: string; body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-configapi-createcatalog" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">CreateCatalog</a>; catalogHrn: string}): Promise<StatusLink>

- Defined in @here/olp-sdk-dataservice-api/lib/config-api.ts:1416

Updates any descriptive and structural information in the catalog. To update a catalog, send a new version of your catalog configuration with the updated data and any required fields.

summary
Updates a catalog

Parameters
- builder: RequestBuilder
- params: {billingTag?: string; body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-configapi-createcatalog" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">CreateCatalog</a>; catalogHrn: string}
 - Optional billingTag?: string
 - body: CreateCatalog
 - catalogHrn: string
Returns Promise<StatusLink>

Index

Interfaces

Type Aliases

Functions

Type Aliases

BillingTags

CRC

ContentEncoding

ContentType

DataRedundancyEnum

DeprecatedPartitioningScheme

Digest

IdEnum

IndexLayerType

InteractiveMapsLayerType

LayerCreated

LayerDescription

LayerHrn

LayerId

LayerName

LayerSummary

MaxMemoryPolicyEnum

ObjectstoreLayerType

PartitioningScheme

RoleEnum

StreamLayerType

Tags

Ttl

TtlEnum

TtlHours

TypeEnum

VersionedLayerType

VolatileLayerType

ZoomLevelEnum

Functions

catalogExists

Parameters

builder: RequestBuilder

Optional billingTag?: string

catalogHrn: string

Returns Promise<Response>

createCatalog

Parameters

builder: RequestBuilder

Optional billingTag?: string

body: CreateCatalog

Returns Promise<StatusLink>

deleteCatalog

Parameters

builder: RequestBuilder

Optional billingTag?: string

catalogHrn: string

Returns Promise<StatusLink>

deleteLayer

Parameters

builder: RequestBuilder

catalogHrn: string

layerId: string

Returns Promise<StatusLink>

disableAutomaticVersionDeletion

Parameters

builder: RequestBuilder

params: {</span>catalogHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}

catalogHrn: string

Returns Promise<StatusLink>

getCatalog

Parameters

builder: RequestBuilder

Optional billingTag?: string

catalogHrn: string

Returns Promise<Catalog>

getCatalogStatus

Parameters

builder: RequestBuilder

Optional billingTag?: string

token: string

Returns Promise<CatalogSuccessStatus>

getCatalogs

Parameters

builder: RequestBuilder