GuidesTypeScript API ReferencePython v2 API Reference

MetadataApi | @here/olp-sdk-ts

MetadataApi | @here/olp-sdk-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace MetadataApi

Index

Interfaces

Functions

Functions

getChanges

  • getChanges(builder: RequestBuilder, params: { additionalFields?: string[]; billingTag?: string; endVersion?: number; layerId: string; range?: string; sinceTime?: number; startVersion?: number }): Promise<MetadataApi.Partitions>

  • Gets the latest partition metadata in a version range for a versioned layer or a time range for a volatile layer. For versioned layers the range is expressed as a start and end version and might not return all changes for the partitions which were added and removed in between the specified start and end versions.

    summary

    Gets changes for the version range.

    Parameters

    • builder: RequestBuilder
    • params: { additionalFields?: string[]; billingTag?: string; endVersion?: number; layerId: string; range?: string; sinceTime?: number; startVersion?: number }
      • Optional additionalFields?: string[]
      • Optional billingTag?: string
      • Optional endVersion?: number
      • layerId: string
      • Optional range?: string
      • Optional sinceTime?: number
      • Optional startVersion?: number

    Returns Promise<MetadataApi.Partitions>

getLayerVersions

  • Returns information about layer versions for the catalog version. It will return an error if the catalog does not have any versions or if the version passed in the query parameter does not exist. If a layer does not have any data for the requested version it is excluded from the response.

    summary

    Gets layer versions for catalog version

    Parameters

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

    Returns Promise<LayerVersions>

getPartitions

  • getPartitions(builder: RequestBuilder, params: { additionalFields?: string[]; billingTag?: string; layerId: string; range?: string; version?: number }): Promise<MetadataApi.Partitions>

  • Gets the metadata for all partitions in a specific layer.

    summary

    Gets partitions

    Parameters

    • builder: RequestBuilder
    • params: { additionalFields?: string[]; billingTag?: string; layerId: string; range?: string; version?: number }
      • Optional additionalFields?: string[]
      • Optional billingTag?: string
      • layerId: string
      • Optional range?: string
      • Optional version?: number

    Returns Promise<MetadataApi.Partitions>

latestVersion

  • Returns information about the latest version for the given catalog. If the catalog doesn't contain any versions a 404 will be returned.

    summary

    Gets the latest available catalog version

    Parameters

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

    Returns Promise<VersionResponse>

listVersions

  • listVersions(builder: RequestBuilder, params: { billingTag?: string; endVersion: number; startVersion: number }): Promise<VersionInfos>

  • Returns information about specific catalog version(s). If the catalog doesn't contain any versions 404 will be returned. Maximum number of versions to be returned per call is 1000 versions. If requested range is bigger than 1000 versions 400 Bad Request will be returned

    summary

    Gets catalog versions

    Parameters

    • builder: RequestBuilder
    • params: { billingTag?: string; endVersion: number; startVersion: number }
      • Optional billingTag?: string
      • endVersion: number
      • startVersion: number

    Returns Promise<VersionInfos>

minimumVersion

Legend

  • Namespace
  • Variable
  • Function
  • Type alias
  • Class
  • Class with type parameter
  • Enumeration
  • Interface

Settings

Theme

Generated using TypeDoc