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 cancelMultipartUploadByKey(hrn: String, layerId: String, multipartToken: String): ApiRequest[Unit]

   Cancels an entire multipart upload operation.

   Cancels an entire multipart upload operation. You can only cancel a multipart upload before it has been completed.

   Path: /layers/{layerId}/keysMultipart/{multipartToken}

   Method: DELETE

   Expected answers:

   code 202 : (Accepted - the data blob was successfully deleted.) Headers : X-Correlation-ID -

   code 400 : ValidationError (User Error - Invalid input is provided) Headers : X-Correlation-ID -

   code 401 : (Unauthorized - the request didn't provide correct authentication details) Headers : X-Correlation-ID -

   code 403 : (Forbidden - the specific account doesn't have correct privileges to perform the operation) Headers : X-Correlation-ID -

   code 404 : (Not Found - the specified resource was not found) Headers : X-Correlation-ID -

   code 500 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

   code 502 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

   code 503 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

   code 504 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

   hrn

   The HERE Resource Name (HRN) of the catalog.

   layerId

   The ID of the parent layer for this blob.

   multipartToken

   The identifier of the multipart upload (token). This token is returned when the multipart upload is initiated.

6.  def clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... ) @native()

7.  def completeMultipartUploadByKey(hrn: String, layerId: String, multipartToken: String, multipartCompletePayload: Option[MultipartCompletePayload] = None)(implicit multipartCompletePayloadBodySerializer: BodySerializer[Option[MultipartCompletePayload]]): ApiRequest[Unit]

   Call this API when all parts have been uploaded.

   Call this API when all parts have been uploaded.

   Path: /layers/{layerId}/keysMultipart/{multipartToken}

   Method: PUT

   Expected answers:

   code 204 : (No Content) Headers : X-Correlation-ID -

   code 400 : ValidationError (User Error - Invalid input is provided) Headers : X-Correlation-ID -

   code 401 : (Unauthorized - the request didn't provide correct authentication details) Headers : X-Correlation-ID -

   code 403 : (Forbidden - the specific account doesn't have correct privileges to perform the operation) Headers : X-Correlation-ID -

   code 404 : (Not Found - the specified resource was not found) Headers : X-Correlation-ID -

   code 500 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

   code 502 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

   code 503 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

   code 504 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

   hrn

   The HERE Resource Name (HRN) of the catalog.

   layerId

   The ID of the parent layer for this blob.

   multipartToken

   The identifier of the multipart upload (token). This token is returned when the multipart upload is initiated.

   multipartCompletePayload

   The part IDs uploaded in this multipart upload which should be used in the resulting blob.

8.  def deleteBlobByKey(hrn: String, layerId: String, key: String): ApiRequest[Unit]

   Deletes a data blob.

   Deletes a data blob.

   Path: /layers/{layerId}/keys/{key}

   Method: DELETE

   Expected answers:

   code 202 : (Accepted - the data blob was successfully deleted.) Headers : X-Correlation-ID -

   code 400 : ValidationError (User Error - Invalid input is provided) Headers : X-Correlation-ID -

   code 401 : (Unauthorized - the request didn't provide correct authentication details) Headers : X-Correlation-ID -

   code 403 : (Forbidden - the specific account doesn't have correct privileges to perform the operation) Headers : X-Correlation-ID -

   code 500 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

   code 502 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

   code 503 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

   code 504 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

   hrn

   The HERE Resource Name (HRN) of the catalog.

   layerId

   The ID of the parent layer for this blob.

   key

   The key identifies a specific blob so that you can get that blob's contents. Key can only contain allowed characters: a-zA-Z0-9.[]=(){}/_-.

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

   Definition Classes

   AnyRef

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

    Definition Classes

    AnyRef → Any

11.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

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

12.  def getBlobByKey(hrn: String, layerId: String, key: String, range: Option[String] = None): ApiRequest[Array[Byte]]

    Retrieves a blob from storage.

    Retrieves a blob from storage.

    Path: /layers/{layerId}/keys/{key}

    Method: GET

    Expected answers:

    code 200 : Array[Byte] (OK - response includes a blob.) Headers : X-Correlation-ID - Content-Length - Last-Modified - Content-Type - Content-Encoding -

    code 206 : Array[Byte] (Partial Content - indicates response to the range query as per [RFC 7233](https://tools.ietf.org/html/rfc7233).) Headers : X-Correlation-ID -

    code 400 : ValidationError (User Error - Invalid input is provided) Headers : X-Correlation-ID -

    code 401 : (Unauthorized - the request didn't provide correct authentication details) Headers : X-Correlation-ID -

    code 403 : (Forbidden - the specific account doesn't have correct privileges to perform the operation) Headers : X-Correlation-ID -

    code 404 : (Not Found - the specified resource was not found) Headers : X-Correlation-ID -

    code 416 : (Range is not valid - indicates errors in the range parameter as per [RFC 7233](https://tools.ietf.org/html/rfc7233).) Headers : X-Correlation-ID -

    code 500 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 502 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 503 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 504 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    hrn

    The HERE Resource Name (HRN) of the catalog.

    layerId

    The ID of the parent layer for this blob.

    key

    The key identifies a specific blob so that you can get that blob's contents. Key can only contain allowed characters: a-zA-Z0-9.[]=(){}/_-.

    range

    Use this parameter to resume download of a large response when there is a connection issue between the client and server, or to fetch a specific slice of the blob. To resume download after a connection issue, specify a single byte range offset as follows: Range: bytes=10-. To fetch a specific slice of the blob, specify a slice as follows: Range: bytes=10-100. This parameter is compliant with [RFC 7233](https://tools.ietf.org/html/rfc7233), but note that this parameter only supports a single byte range. You can also specify the range parameter as a query parameter, for example range=bytes=10-.

13.  def getBlobMetadataByKey(hrn: String, layerId: String, key: String): ApiRequest[Unit]

    Checks if a blob exists for the requested key.

    Checks if a blob exists for the requested key. You can also use it to fetch object metadata.

    Path: /layers/{layerId}/keys/{key}

    Method: HEAD

    Expected answers:

    code 200 : (OK - key exists.) Headers : X-Correlation-ID - Content-Length - Last-Modified - Content-Type - Content-Encoding -

    code 401 : (Unauthorized - the request didn't provide correct authentication details) Headers : X-Correlation-ID -

    code 403 : (Forbidden - the specific account doesn't have correct privileges to perform the operation) Headers : X-Correlation-ID -

    code 404 : (Not Found - the specified resource was not found) Headers : X-Correlation-ID -

    code 500 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 502 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 503 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 504 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    hrn

    The HERE Resource Name (HRN) of the catalog.

    layerId

    The ID of the parent layer for this blob.

    key

    The key identifies a specific blob so that you can get that blob's contents. Key can only contain allowed characters: a-zA-Z0-9.[]=(){}/_-.

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

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

15.  def getMultipartUploadStatusByKey(hrn: String, layerId: String, multipartToken: String): ApiRequest[MultipartKeyUploadStatus]

    Gets the status of a multipart upload.

    Gets the status of a multipart upload. The status can be received only when the upload has been completed.

    Path: /layers/{layerId}/keysMultipart/{multipartToken}

    Method: GET

    Expected answers:

    code 200 : MultipartKeyUploadStatus (OK) Headers : X-Correlation-ID -

    code 400 : ValidationError (User Error - Invalid input is provided) Headers : X-Correlation-ID -

    code 401 : (Unauthorized - the request didn't provide correct authentication details) Headers : X-Correlation-ID -

    code 403 : (Forbidden - the specific account doesn't have correct privileges to perform the operation) Headers : X-Correlation-ID -

    code 404 : (Not Found - the specified resource was not found) Headers : X-Correlation-ID -

    code 500 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 502 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 503 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 504 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    hrn

    The HERE Resource Name (HRN) of the catalog.

    layerId

    The ID of the parent layer for this blob.

    multipartToken

    The identifier of the multipart upload (token). This token is returned when the multipart upload is initiated.

16.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

17.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

18.  def listKeys(hrn: String, layerId: String, parent: Option[String] = None, pageToken: Option[String] = None, limit: Option[Int] = None, deep: Option[Boolean] = None): ApiRequest[KeysListResponse]

    List virtual directory-like structure created from keys in the storage where '/' is used as a separator.

    List virtual directory-like structure created from keys in the storage where '/' is used as a separator.

    Path: /layers/{layerId}/keys

    Method: GET

    Expected answers:

    code 200 : KeysListResponse (OK - Response includes a list of keys.) Headers : X-Correlation-ID -

    code 400 : ValidationError (User Error - Invalid input is provided) Headers : X-Correlation-ID -

    code 401 : (Unauthorized - the request didn't provide correct authentication details) Headers : X-Correlation-ID -

    code 403 : (Forbidden - the specific account doesn't have correct privileges to perform the operation) Headers : X-Correlation-ID -

    code 500 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 502 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 503 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 504 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    hrn

    The HERE Resource Name (HRN) of the catalog.

    layerId

    The ID of the parent layer for this blob.

    parent

    Common prefix to a list.

    pageToken

    If specified, will return the specific page based on the token.

    limit

    Number of results to return per page.

    deep

    Use deep (recursive) listing of objects instead of hierarchical listing. Deep listing will not produce any common prefixes.

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

    Definition Classes

    AnyRef

20.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

21.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

22.  def putBlobByKey(hrn: String, layerId: String, key: String, source: Option[String] = None, contentLength: Option[Long] = None, contentType: Option[String] = None, contentEncoding: Option[String] = None, body: Option[Array[Byte]] = None)(implicit bodyBodySerializer: BodySerializer[Option[Array[Byte]]]): ApiRequest[Unit]

    Persists the data blob up to 192 MB.

    Persists the data blob up to 192 MB. When the operation completes successfully, there is no guarantee that the data blob will be immediately available, although in most cases, it will be. To check if the data blob is available, use the ´HEAD´ method. The maximum key length is 450 characters.

    Path: /layers/{layerId}/keys/{key}

    Method: PUT

    Expected answers:

    code 200 : (OK) Headers : X-Correlation-ID -

    code 400 : ValidationError (User Error - Invalid input is provided) Headers : X-Correlation-ID -

    code 401 : (Unauthorized - the request didn't provide correct authentication details) Headers : X-Correlation-ID -

    code 403 : (Forbidden - the specific account doesn't have correct privileges to perform the operation) Headers : X-Correlation-ID -

    code 404 : (Not Found - the specified resource was not found) Headers : X-Correlation-ID -

    code 413 : (Request entity too large - request made from a client is too large to be processed by the server.) Headers : X-Correlation-ID -

    code 500 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 502 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 503 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 504 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    hrn

    The HERE Resource Name (HRN) of the catalog.

    layerId

    The ID of the parent layer for this blob.

    key

    The key identifies a specific blob so that you can get that blob's contents. Key can only contain allowed characters: a-zA-Z0-9.[]=(){}/_-.

    source

    Copy an existing object, instead of uploading a new one. If this parameter is present, the request payload must be empty.

    contentLength

    This header relates to upload only. Size of the entity-body, in bytes. For more information, see [RFC 7230, section 3.3.2: Content-Length](https://tools.ietf.org/html/rfc7230#section-3.3.2).

    contentType

    This header relates to upload only. A standard MIME type describing the format of the blob data. For more information, see [RFC 2616, section 14.17: Content-Type](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). The value of this header must match the content type specified in the contentType field when the multipart upload was initialized, and this content type must also match the content type specified in the layer's configuration.

    contentEncoding

    Content-encoding of the object. This header is optional. For more information, see [RFC 2616, section 14.11: Content-Encoding](https://tools.ietf.org/html/rfc2616#section-14.11).

    body

    Request body. Must be empty when copying an object using the source parameter.

23.  def startMultipartUploadByKey(hrn: String, layerId: String, key: String, multipartUploadByKeyMetadata: MultipartUploadByKeyMetadata)(implicit multipartUploadByKeyMetadataBodySerializer: BodySerializer[MultipartUploadByKeyMetadata]): ApiRequest[MultipartInitResponse]

    Publishes large data blobs where the data payload needs to be split into multiple parts.

    Publishes large data blobs where the data payload needs to be split into multiple parts. The multipart upload start is to be followed by the individual parts upload and completed with a call to complete the upload. The limit of the blob uploaded this way is 500GB. Max key length is 450 characters.

    Path: /layers/{layerId}/keys/{key}

    Method: POST

    Expected answers:

    code 200 : MultipartInitResponse (OK - the new multipart upload was successfully started.) Headers : X-Correlation-ID -

    code 400 : ValidationError (User Error - Invalid input is provided) Headers : X-Correlation-ID -

    code 401 : (Unauthorized - the request didn't provide correct authentication details) Headers : X-Correlation-ID -

    code 403 : (Forbidden - the specific account doesn't have correct privileges to perform the operation) Headers : X-Correlation-ID -

    code 404 : (Not Found - the specified resource was not found) Headers : X-Correlation-ID -

    code 500 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 502 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 503 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 504 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    hrn

    The HERE Resource Name (HRN) of the catalog.

    layerId

    The ID of the parent layer for this blob.

    key

    The key identifies a specific blob so that you can get that blob's contents. Key can only contain allowed characters: a-zA-Z0-9.[]=(){}/_-.

    multipartUploadByKeyMetadata

    An object that contains metadata of the uploaded object.

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

    Definition Classes

    AnyRef

25.  def toString(): String

    Definition Classes

    AnyRef → Any

26.  def uploadPartByKey(hrn: String, layerId: String, multipartToken: String, partNumber: Int, contentLength: Option[Long] = None, contentType: Option[String] = None, source: Option[String] = None, range: Option[String] = None, body: Option[Array[Byte]] = None)(implicit bodyBodySerializer: BodySerializer[Option[Array[Byte]]]): ApiRequest[PartId]

    Upload or copy a single part of a multipart upload or multipart copy for the blob.

    Upload or copy a single part of a multipart upload or multipart copy for the blob. Every part except the last one must have a minimum 5 MB of data and maximum of 96 MB. The length of every part except the last must be a multiple of 1MB (1024KB). The maximum number of parts is 10,000.

    Path: /layers/{layerId}/keysMultipart/{multipartToken}/parts

    Method: POST

    Expected answers:

    code 200 : PartId (OK - part was uploaded successfully) Headers : X-Correlation-ID -

    code 400 : ValidationError (User Error - Invalid input is provided) Headers : X-Correlation-ID -

    code 401 : (Unauthorized - the request didn't provide correct authentication details) Headers : X-Correlation-ID -

    code 403 : (Forbidden - the specific account doesn't have correct privileges to perform the operation) Headers : X-Correlation-ID -

    code 404 : (Not Found - the specified resource was not found) Headers : X-Correlation-ID -

    code 413 : (Request entity too large - request made from a client is too large to be processed by the server.) Headers : X-Correlation-ID -

    code 416 : (Request range is not valid - request made from a client has invalid range.) Headers : X-Correlation-ID -

    code 500 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 502 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 503 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    code 504 : ServerError (Server unavailable or internal server error) Headers : X-Correlation-ID -

    hrn

    The HERE Resource Name (HRN) of the catalog.

    layerId

    The ID of the parent layer for this blob.

    multipartToken

    The identifier of the multipart upload (token). This token is returned when the multipart upload is initiated.

    partNumber

    This parameter relates to upload and copy. The number of the part for the multipart upload or copy. The numbers of the upload parts must start from 1, be no greater than 10,000 and be consecutive. Parts uploaded with the same partNumber are overridden. Do not reuse the same partNumber when retrying an upload or copy in an error situation (network problems, 4xx or 5xx responses). Reusing the same partNumber in a retry may cause the publication to fail.

    contentLength

    This header relates to upload only. Size of the entity-body, in bytes. For more information, see [RFC 7230, section 3.3.2: Content-Length](https://tools.ietf.org/html/rfc7230#section-3.3.2).

    contentType

    This header relates to upload only. A standard MIME type describing the format of the blob data. For more information, see [RFC 2616, section 14.17: Content-Type](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). The value of this header must match the content type specified in the contentType field when the multipart upload was initialized, and this content type must also match the content type specified in the layer's configuration.

    source

    Copy part from an existing object, use range to specify which parts of the object to copy.

    range

    This header/parameter relates to object copy using the 'source' parameter. Use this parameter to copy a specific slice of the blob like this: Range: bytes=0-1048575. This parameter is compliant with [RFC 7233](https://tools.ietf.org/html/rfc7233), but note that this parameter only supports a single byte range and both begin and end values of the range must be specified. The range begin value must be multiple of 1MB (1024KB). The length of every part except the last must be a multiple of 1MB (1024KB). The range parameter can also be specified as a query parameter, for example range=bytes=0-1048575.

    body

    The body relates to upload only. The data to upload as part of the blob.

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): ByKeyApi