trait DataSubsetsApi extends AnyRef

Manage data subsets.

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

Abstract Value Members

  1. abstract def createDataSubsets(catalogHrn: HRN, dataSubsets: Seq[DataSubset]): Future[Done]

    Create data subsets

    Create data subsets

    catalogHrn

    The HERE Resource Name (HRN) of the catalog

    dataSubsets

    The data subsets to create.

    returns

    future stage which completes when the data subsets are created.

    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 deleteDataSubset(catalogHrn: HRN, dataSubsetId: String): Future[Done]

    Delete a data subset

    Delete a data subset

    catalogHrn

    The HERE Resource Name (HRN) of the catalog

    dataSubsetId

    The dats subset ID.

    returns

    future stage which completes when the data subset is deleted.

    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

  3. abstract def getDataSubset(catalogHrn: HRN, dataSubsetId: String): Future[DataSubset]

    Get the details of a data subset

    Get the details of a data subset

    catalogHrn

    The HERE Resource Name (HRN) of the catalog

    dataSubsetId

    The data subset ID.

    returns

    details of a data subset

    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

  4. abstract def getDataSubsets(catalogHrn: HRN, limit: Option[Int], areas: Option[Seq[String]], layers: Option[Seq[String]]): Future[Seq[DataSubset]]

    Get the list of all accessible data subsets which match the optional areas or layers filter

    Get the list of all accessible data subsets which match the optional areas or layers filter

    catalogHrn

    The HERE Resource Name (HRN) of the catalog

    limit

    Optional number of maximum elements in data subsets list response.

    areas

    Optional list of areaIds which is used to filter the data subsets list response.

    layers

    Optional list of layerIds which is used to filter the data subsets list response.

    returns

    list of data subsets

    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

  5. abstract def getDataSubsetsAsSource(catalogHrn: HRN, limit: Option[Int], areas: Option[Seq[String]], layers: Option[Seq[String]]): Future[Source[DataSubset, NotUsed]]

    Get the list of all accessible data subsets which match the optional areas or layers filter

    Get the list of all accessible data subsets which match the optional areas or layers filter

    catalogHrn

    The HERE Resource Name (HRN) of the catalog

    limit

    Optional number of maximum elements in data subsets list response.

    areas

    Optional list of areaIds which is used to filter the data subsets list response.

    layers

    Optional list of layerIds which is used to filter the data subsets list response.

    returns

    list of data subsets as a Pekko 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

  6. abstract def getDataSubsetsFingerprint(catalogHrn: HRN): Future[DataSubsetsFingerprint]

    Get data subsets fingerprint

    Get data subsets fingerprint

    catalogHrn

    The HERE Resource Name (HRN) of the catalog

    returns

    Data subsets fingerprint

    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

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