Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

4.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

5.  def clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... ) @native()

6.  def compatibleVersions(hrn: String, dependencies: Dependencies, limit: Option[Int] = None, strict: Option[Boolean] = None)(implicit dependenciesBodySerializer: BodySerializer[Dependencies]): ApiRequest[VersionsResponse]

   Given a list of HRNs and versions provided by the user, returns a list of versions of this catalog for which the listed HRN are either present in the direct or indirect dependencies with the same version, or are not present.

   Given a list of HRNs and versions provided by the user, returns a list of versions of this catalog for which the listed HRN are either present in the direct or indirect dependencies with the same version, or are not present. Depending on 'strict' flag versions that don't depend on any of the provided catalog HRNs, can also be considered compatible. The compatible versions are returned in reverse order, from the newest to the oldest. When there is no compatible version the service returns an empty list. When the catalog has no version a 404 is returned.

   Path: /versions/compatibles

   Method: POST

   Expected answers:

   code 200 : VersionsResponse (OK)

   code 400 : (Bad Request - indicates that request failed fast validation e.g. syntax, some logical errors or required parameters are missing)

   code 401 : (Unauthorized)

   code 403 : (Forbidden)

   code 404 : (Catalog does not exist or the catalog doesn't contain any versions)

   code 500 : (Internal Server Error)

   code 503 : (Service Unavailable)

   hrn

   The HERE Resource Name (HRN) of the catalog.

   dependencies

   The catalog dependencies we want to search for

   limit

   The numbers of items to return per page

   strict

   if 'strict=true' versions to be considered compatible should depend on at least one of the provided catalog HRNs.

7.  final def eq(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

8.  def equals(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

9.  def finalize(): Unit

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( classOf[java.lang.Throwable] )

10.  def getChanges(hrn: String, nextUrl: Option[String] = None, layerId: String, startVersion: Option[Long] = None, endVersion: Option[Long] = None, sinceTime: Option[Long] = None, part: Option[String] = None, context: Option[String] = None, additionalFields: Seq[String] = Nil, range: Option[String] = None, billingTag: Option[String] = None): ApiRequest[Partitions]

    Gets the latest partition metadata in a version range for a versioned layer or a time range for a volatile layer.

    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.

    Path: /layers/{layerId}/changes

    Method: GET

    Expected answers:

    code 200 : Partitions (OK) Headers : Last-Modified - The date and time at which the resource was last modified

    code 206 : Partitions (Partial response in case the server provides and accepts range query parameter or Content-Range header) Headers : Last-Modified - The date and time at which the resource was last modified

    code 400 : (Required parameters are missing)

    code 401 : (Unauthorized)

    code 403 : (Forbidden)

    code 404 : (Catalog or layer does not exist)

    code 416 : (Range Not Satisfiable, invalid range query parameter or Content-Range header)

    code 500 : (Internal Server Error)

    code 503 : (Service Unavailable) Headers : Retry-After - Retry after the specified number of seconds

    hrn

    The HERE Resource Name (HRN) of the catalog.

    nextUrl

    Already constructed url with path parameters but without query.

    layerId

    Unique layer ID. Content of this parameter must refer to a valid layer ID.

    startVersion

    Available/Required for versioned layers only; the beginning of the range of versions you want to get (exclusive). By convention -1 indicates the initial version before the first publication. After the first publication, the catalog version is 0.

    endVersion

    Available/Required for versioned layers only; the end of the range of versions you want to get (inclusive). This must be a valid catalog version greater than the startVersion.

    sinceTime

    Available/Required for volatile layers only; will return partitions whose data has been modified since this time, in milliseconds since epoch, inclusive.

    part

    Available/Required for versioned layers only; indicates which part of the layer shall be queried.

    context

    The context where the operation will be performed on a composite layers. Only available for versioned layers. Available context are: |Context|Description| |-------|-----------| |default|The default value if none is given. For composite layers the operation is executed for both layers current and the layer it extends. For normal layers this is the only valid context.| |extension|The operation will be executed only in the extension and no operation will be performed in the extended layer.| |super| The operation will be executed only in the layer being extended (super layer).|

    additionalFields

    Additional fields - dataSize, checksum, compressedDataSize, crc.

    range

    Use this parameter to resume download of a large response for versioned layers when there is a connection issue between the client and server. Specify a single byte range offset like this: Range: bytes=10-. This parameter is compliant with [RFC 7233](https://tools.ietf.org/html/rfc7233), but note that this parameter only supports a single byte range. The range parameter can also be specified as a query parameter, i.e. range=bytes=10-. For volatile layers use the pagination links returned in the response body.

    billingTag

    Billing Tag is an optional free-form tag which is used for grouping billing records together. If supplied, it must be between 4 - 16 characters, contain only alpha/numeric ASCII characters [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases.

11.  def getChangesParts(hrn: String, layerId: String, numRequestedParts: Int): ApiRequest[PartsResponse]

    Returns a list of Part Ids which represent the parts that can be used to limit the scope of queries of changes for the version range.

    Returns a list of Part Ids which represent the parts that can be used to limit the scope of queries of changes for the version range. This allows to run parallel queries with multiple parts. The user has to provide the desired number of parts and the service will return a list of Part Ids. Please note in some cases the requested number of parts will make them too small and in this case the service might return lesser amount of the parts than requested.

    Path: /layers/{layerId}/changes/parts

    Method: GET

    Expected answers:

    code 200 : PartsResponse (OK - Operation executed successfully)

    code 400 : (Bad Request - The request is invalid. Verify number of requested parts and retry.)

    code 401 : (Unauthorized - The credentials provided do not authorize the user to perform this operation.)

    code 403 : (Forbidden - The user is not authorized to perform the query on the resource specified.)

    code 404 : (Not Found - A layer with the given name does not exist.)

    hrn

    The HERE Resource Name (HRN) of the catalog.

    layerId

    Unique layer ID. Content of this parameter must refer to a valid layer ID.

    numRequestedParts

    Indicates requested number of parts.

12.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

13.  def getLayersVersion(hrn: String, version: Long, billingTag: Option[String] = None): ApiRequest[LayerVersions]

    Returns information about layer versions for the catalog version.

    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.

    Path: /layerVersions

    Method: GET

    Expected answers:

    code 200 : LayerVersions (OK)

    code 400 : (Required parameters are missing)

    code 401 : (Unauthorized)

    code 403 : (Forbidden)

    code 404 : (Catalog does not exist)

    hrn

    The HERE Resource Name (HRN) of the catalog.

    version

    Catalog version

    billingTag

    Billing Tag is an optional 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]. Grouping billing records by billing tag will be available in future releases.

14.  def getPartitions(hrn: String, nextUrl: Option[String] = None, layerId: String, version: Option[Long] = None, part: Option[String] = None, context: Option[String] = None, additionalFields: Seq[String] = Nil, range: Option[String] = None, billingTag: Option[String] = None): ApiRequest[Partitions]

    Gets the metadata for all partitions in a specific layer.

    Gets the metadata for all partitions in a specific layer.

    Path: /layers/{layerId}/partitions

    Method: GET

    Expected answers:

    code 200 : Partitions (OK) Headers : Last-Modified - The date and time at which the resource was last modified

    code 206 : Partitions (Partial response in case the server provides and accepts range query parameter or Content-Range header) Headers : Last-Modified - The date and time at which the resource was last modified

    code 400 : (Required parameters are missing)

    code 401 : (Unauthorized)

    code 403 : (Forbidden)

    code 404 : (Catalog or layer does not exist)

    code 416 : (Range Not Satisfiable, invalid range query parameter or Content-Range header)

    code 500 : (Internal Server Error)

    code 503 : (Service Unavailable) Headers : Retry-After - Retry after the specified number of seconds

    hrn

    The HERE Resource Name (HRN) of the catalog.

    nextUrl

    Already constructed url with path parameters but without query.

    layerId

    Unique layer ID. Content of this parameter must refer to a valid layer ID.

    version

    If you are getting metadata from a versioned layer, specify the version of the layer you want. This parameter is required for versioned layers. If you are getting metadata from another layer type, do not specify this parameter.

    part

    Available/Required for versioned layers only; indicates which part of the layer shall be queried.

    context

    The context where the operation will be performed on a composite layers. Only available for versioned layers. Available context are: |Context|Description| |-------|-----------| |default|The default value if none is given. For composite layers the operation is executed for both layers current and the layer it extends. For normal layers this is the only valid context.| |extension|The operation will be executed only in the extension and no operation will be performed in the extended layer.| |super| The operation will be executed only in the layer being extended (super layer).|

    additionalFields

    Additional fields - dataSize, checksum, compressedDataSize, crc.

    range

    Use this parameter to resume download of a large response for versioned layers when there is a connection issue between the client and server. Specify a single byte range offset like this: Range: bytes=10-. This parameter is compliant with [RFC 7233](https://tools.ietf.org/html/rfc7233), but note that this parameter only supports a single byte range. The range parameter can also be specified as a query parameter, i.e. range=bytes=10-. For volatile layers use the pagination links returned in the response body.

    billingTag

    Billing Tag is an optional free-form tag which is used for grouping billing records together. If supplied, it must be between 4 - 16 characters, contain only alpha/numeric ASCII characters [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases.

15.  def getPartitionsParts(hrn: String, layerId: String, numRequestedParts: Int): ApiRequest[PartsResponse]

    Returns a list of Part Ids which represent the parts that can be used to limit the scope of queries of the metadata for all partitions in a specific layer.

    Returns a list of Part Ids which represent the parts that can be used to limit the scope of queries of the metadata for all partitions in a specific layer. This allows to run parallel queries with multiple parts. The user has to provide the desired number of parts and the service will return a list of Part Ids. Please note in some cases the requested number of parts will make them too small and in this case the service might return lesser amount of the parts than requested.

    Path: /layers/{layerId}/partitions/parts

    Method: GET

    Expected answers:

    code 200 : PartsResponse (OK - Operation executed successfully)

    code 400 : (Bad Request - The request is invalid. Verify number of requested parts and retry.)

    code 401 : (Unauthorized - The credentials provided do not authorize the user to perform this operation.)

    code 403 : (Forbidden - The user is not authorized to perform the query on the resource specified.)

    code 404 : (Not Found - A layer with the given name does not exist.)

    hrn

    The HERE Resource Name (HRN) of the catalog.

    layerId

    Unique layer ID. Content of this parameter must refer to a valid layer ID.

    numRequestedParts

    Indicates requested number of parts.

16.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

17.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

18.  def latestVersion(hrn: String, startVersion: Long, billingTag: Option[String] = None): ApiRequest[VersionResponse]

    Returns information about the latest version for the given catalog.

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

    Path: /versions/latest

    Method: GET

    Expected answers:

    code 200 : VersionResponse (OK)

    code 400 : (Bad Request - indicates that the request failed the validation, e.g. syntax check is failing, logical errors exist or required parameters are missing.)

    code 401 : (Unauthorized)

    code 403 : (Forbidden)

    code 404 : (Catalog does not exist or the catalog doesn't contain any versions.)

    hrn

    The HERE Resource Name (HRN) of the catalog.

    startVersion

    The catalog version returned from a prior request to /versions/latest. You should save the version from each request so that you can use it in the startVersion parameter of subsequent requests. If you don't have the version from a prior request, set the parameter to -1.

    billingTag

    Billing Tag is an optional free-form tag which is used for grouping billing records together. If supplied, it must be between 4 - 16 characters, contain only alpha/numeric ASCII characters [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases.

19.  def listVersions(hrn: String, startVersion: Long, endVersion: Long, billingTag: Option[String] = None): ApiRequest[VersionInfos]

    Returns information about specific catalog version(s).

    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

    Path: /versions

    Method: GET

    Expected answers:

    code 200 : VersionInfos (OK)

    code 400 : (Bad Request - indicates that request failed fast validation e.g. syntax, some logical errors or required parameters are missing)

    code 401 : (Unauthorized)

    code 403 : (Forbidden)

    code 404 : (Catalog does not exist or the catalog doesn't contain any versions)

    code 500 : (Internal Server Error)

    code 503 : (Service Unavailable) Headers : Retry-After - Retry after the specified number of seconds

    hrn

    The HERE Resource Name (HRN) of the catalog.

    startVersion

    The beginning of the range of versions you want to get (exclusive). By convention -1 indicates the initial version before the first publication. After the first publication, the catalog version is 0.

    endVersion

    The end of the range of versions you want to get (inclusive). This must be a valid catalog version greater than the startVersion. The maximum value for this parameter is returned from the /versions/latest endpoint. If this version does not exist, 400 Bad Request is returned

    billingTag

    Billing Tag is an optional free-form tag which is used for grouping billing records together. If supplied, it must be between 4 - 16 characters, contain only alpha/numeric ASCII characters [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases.

20.  def minimumVersion(hrn: String, billingTag: Option[String] = None): ApiRequest[VersionResponse]

    Returns minimum version for the given catalog.

    Returns minimum version for the given catalog. If the catalog doesn't contain any versions 404 will be returned.

    Path: /versions/minimum

    Method: GET

    Expected answers:

    code 200 : VersionResponse (OK)

    code 400 : (Bad Request - indicates that the request failed the validation, e.g. syntax check is failing, logical errors exist or required parameters are missing.)

    code 401 : (Unauthorized)

    code 403 : (Forbidden)

    code 404 : (Catalog does not exist or the catalog doesn't contain any versions.)

    hrn

    The HERE Resource Name (HRN) of the catalog.

    billingTag

    Billing Tag is an optional free-form tag which is used for grouping billing records together. If supplied, it must be between 4 - 16 characters, contain only alpha/numeric ASCII characters [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases.

21.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

22.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

23.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

24.  def setMinimumVersion(hrn: String, minimumVersionInfo: MinimumVersionInfo, billingTag: Option[String] = None)(implicit minimumVersionInfoBodySerializer: BodySerializer[MinimumVersionInfo]): ApiRequest[Unit]

    Sets minimum version for the given catalog.

    Sets minimum version for the given catalog. All prior versions will be deleted. If the catalog doesn't contain any versions, a 404 will be returned.

    Path: /versions/minimum

    Method: POST

    Expected answers:

    code 204 : (Minimum version was set successfully.)

    code 400 : (Bad Request - indicates that the request failed the validation, e.g. syntax check is failing, logical errors exist or required parameters are missing.)

    code 401 : (Unauthorized)

    code 403 : (Forbidden)

    code 404 : (Catalog does not exist or the catalog doesn't contain any versions.)

    hrn

    The HERE Resource Name (HRN) of the catalog.

    minimumVersionInfo

    A version object that contains new minimum version.

    billingTag

    Billing Tag is an optional free-form tag which is used for grouping billing records together. If supplied, it must be between 4 - 16 characters, contain only alpha/numeric ASCII characters [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases.

25.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

26.  def toString(): String

    Definition Classes

    AnyRef → Any

27.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

28.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

29.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... ) @native()

30.  def withConfig(apiConfig: ApiConfiguration): MetadataApi