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

Class DataClient

java.lang.Object
com.here.platform.data.client.javadsl.DataClient
All Implemented Interfaces:
DataClientApi, org.apache.pekko.actor.Extension
public final class DataClient extends Object implements DataClientApi, org.apache.pekko.actor.Extension
Entry point of the Java data-client module.

Use provided API objects to query and publish metadata for catalogs and layers.

DataEngineExt's provided API objects can later interact with this metadata to upload, or download, actual data to/from the layer's storage.

Use DataClient.get to access the global instance.

Consider passing this global instance as a DataClientApi for unit testing purposes.

  • Constructor Details

    • DataClient

      public DataClient(org.apache.pekko.actor.ActorSystem system)

  • Method Details

    • get

      public static DataClient get(org.apache.pekko.actor.ActorSystem system)

    • lookup

      public static com.here.platform.data.client.javadsl.DataClient$ lookup()

    • createExtension

      public static DataClient createExtension(org.apache.pekko.actor.ExtendedActorSystem system)

    • apply

      public static T apply(org.apache.pekko.actor.ActorSystem system)

    • apply

      public static T apply(org.apache.pekko.actor.ClassicActorSystemProvider system)

    • hashCode

      public static final int hashCode()

    • equals

      public static final boolean equals(Object other)

    • defaultSettings

      public Settings defaultSettings()
      Description copied from interface: DataClientApi
      Default setting which will be used if no overrides is provided
      Specified by:
      defaultSettings in interface DataClientApi

    • queryApi

      public QueryApi queryApi(HRN hrn)
      Description copied from interface: DataClientApi
      Create a catalog query API object

      Specified by:
      queryApi in interface DataClientApi
      Parameters:
      hrn - catalog identifier
      Returns:
      catalog query API if catalog exists, return error if catalog does not exists

    • queryApi

      public QueryApi queryApi(HRN hrn, Settings settings)
      Description copied from interface: DataClientApi
      Create a catalog query API object

      Specified by:
      queryApi in interface DataClientApi
      Parameters:
      hrn - catalog identifier
      settings - setting to be used while using query API
      Returns:
      catalog query API if catalog exists, return error if catalog does not exists

    • publishApi

      public PublishApi publishApi(HRN hrn)
      Description copied from interface: DataClientApi
      Create a catalog publish API object

      Specified by:
      publishApi in interface DataClientApi
      Parameters:
      hrn - catalog identifier
      Returns:
      catalog publish API if catalog exists, return error if catalog does not exists

    • publishApi

      public PublishApi publishApi(HRN hrn, Settings settings)
      Description copied from interface: DataClientApi
      Create a catalog publish API object

      Specified by:
      publishApi in interface DataClientApi
      Parameters:
      hrn - catalog identifier
      settings - setting to be used while using publish API
      Returns:
      catalog publish API if catalog exists, return error if catalog does not exists

    • adminApi

      public AdminApi adminApi(Settings settings)
      Description copied from interface: DataClientApi
      Create a catalog admin API object

      Specified by:
      adminApi in interface DataClientApi
      Parameters:
      settings - setting to be used while using admin API
      Returns:
      catalog admin API

    • adminApi

      public AdminApi adminApi()
      Description copied from interface: DataClientApi
      Create a catalog admin API object

      Specified by:
      adminApi in interface DataClientApi
      Returns:
      catalog admin API

    • invalidateCache

      public void invalidateCache(HRN hrn)
      Description copied from interface: DataClientApi
      Invalidate internal caches for catalog

      Specified by:
      invalidateCache in interface DataClientApi
      Parameters:
      hrn - catalog identifier

    • getClientExecutionContext

      public ClientExecutionContext getClientExecutionContext()
      Description copied from interface: DataClientApi
      Get client execution context (internal for testing)
      Specified by:
      getClientExecutionContext in interface DataClientApi