Packages

trait FlinkReadEngine extends AnyRef

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FlinkReadEngine
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def asDataFlow(): MapFunction[Partition, Array[Byte]]

    Retrieves an flink map function that download data for each partition.

    Retrieves an flink map function that download data for each partition.

    returns

    the pekko flow

    Exceptions thrown

    com.here.platform.data.client.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

  2. abstract def getDataAsBytes(partition: Partition): Array[Byte]

    Retrieves the blob data associated with the partition as array of bytes

    Retrieves the blob data associated with the partition as array of bytes

    partition

    the partition to retrieve

    returns

    blob data associated with the partition as array of bytes

    Exceptions thrown

    NotFoundException when the partition doesn't have associated payload (e.g. for expired volatile data)

    com.here.platform.data.client.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

    Note

    This method could be used only for downloading data less than 2GB

  3. abstract def getObjectDataAsBytes2(layerId: String, key: String, applyDecompression: Boolean, range: ByteRange = AllBytes): Array[Byte]

    Retrieves the blob data associated with provided key as source.

    Retrieves the blob data associated with provided key as source.

    layerId

    the id of the layer

    key

    the key of the object to get data for

    applyDecompression

    decides whether decompression is applied for the object data.

    range

    the range of bytes to retrieve

    returns

    Blob data associated with key as source.

    Exceptions thrown

    com.here.platform.data.client.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

    com.here.platform.data.client.NotFoundException in case of the key doesn't exist

    java.lang.UnsupportedOperationException in case method called for non-objectstore layer

  4. abstract def getObjectMetadata(layerId: String, key: String): ObjectMetadata

    Retrieves metadata of the key provided in request

    Retrieves metadata of the key provided in request

    layerId

    the id of the layer

    key

    the key for which metadata is requested

    returns

    metadata associated with the specified key

    Exceptions thrown

    com.here.platform.data.client.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

    com.here.platform.data.client.NotFoundException in case of the key doesn't exist

    java.lang.UnsupportedOperationException in case method called for non-objectstore layer

  5. abstract def listObjects(layerId: String, parent: Option[String], deepListEnabled: Boolean = false, pageSize: Option[Int] = None): List[ObjectStoreListItem]

    Retrieves Source of elements under the provided parent key.

    Retrieves Source of elements under the provided parent key.

    If no parent key is provided, root of the layer is used as default key.

    layerId

    the id of the layer

    parent

    the key under which listing items are requested

    deepListEnabled

    in case the flag is set to true all results appear as complete objects

    pageSize

    optional number of objects that are fetched internally per request

    returns

    Source of the listing elements.

    Exceptions thrown

    com.here.platform.data.client.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

    java.lang.UnsupportedOperationException in case method called for non-objectstore layer

Concrete 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(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped