Package com.here.platform.data.client.javadsl

Interface DataSubsetsApi

public interface DataSubsetsApi
Manage data subsets.

  • Method Details

    • createDataSubsets

      CompletionStage<org.apache.pekko.Done> createDataSubsets(HRN catalogHrn, List<DataSubset> dataSubsets)
      Create data subsets
      Parameters:
      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.
      Throws:
      DataClientNonRetriableException - in case of non-retriable error
      DataClientRetriableException - in case of retriable error

    • deleteDataSubset

      CompletionStage<org.apache.pekko.Done> deleteDataSubset(HRN catalogHrn, String dataSubsetId)
      Delete a data subset
      Parameters:
      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.
      Throws:
      DataClientNonRetriableException - in case of non-retriable error
      DataClientRetriableException - in case of retriable error

    • getDataSubset

      CompletionStage<DataSubset> getDataSubset(HRN catalogHrn, String dataSubsetId)
      Get the details of a data subset
      Parameters:
      catalogHrn - The HERE Resource Name (HRN) of the catalog
      dataSubsetId - The data subset ID.
      Returns:
      details of a data subset
      Throws:
      DataClientNonRetriableException - in case of non-retriable error
      DataClientRetriableException - in case of retriable error

    • getDataSubsets

      CompletionStage<List<DataSubset>> getDataSubsets(HRN catalogHrn, OptionalInt limit, Optional<List<String>> areas, Optional<List<String>> layers)
      Get the list of all accessible data subsets which match the optional areas or layers filter
      Parameters:
      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
      Throws:
      DataClientNonRetriableException - in case of non-retriable error
      DataClientRetriableException - in case of retriable error

    • getDataSubsetsAsSource

      CompletionStage<org.apache.pekko.stream.javadsl.Source<DataSubset,org.apache.pekko.NotUsed>> getDataSubsetsAsSource(HRN catalogHrn, OptionalInt limit, Optional<List<String>> areas, Optional<List<String>> layers)
      Get the list of all accessible data subsets which match the optional areas or layers filter
      Parameters:
      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
      Throws:
      DataClientNonRetriableException - in case of non-retriable error
      DataClientRetriableException - in case of retriable error

    • getDataSubsetsFingerprint

      CompletionStage<DataSubsetsFingerprint> getDataSubsetsFingerprint(HRN catalogHrn)
      Get data subsets fingerprint
      Parameters:
      catalogHrn - The HERE Resource Name (HRN) of the catalog
      Returns:
      Data subsets fingerprint
      Throws:
      DataClientNonRetriableException - in case of non-retriable error
      DataClientRetriableException - in case of retriable error