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

Class FlinkAdminApiImpl

java.lang.Object
com.here.platform.data.client.flink.javadsl.FlinkAdminApiImpl
All Implemented Interfaces:
FlinkAdminApi
public final class FlinkAdminApiImpl extends Object implements FlinkAdminApi

  • Constructor Details

    • FlinkAdminApiImpl

      public FlinkAdminApiImpl(Settings settings, scala.Function0<DataClientApi> toCreateDataClient)

  • Method Details

    • checkIfCatalogExists

      public Boolean checkIfCatalogExists(HRN hrn)
      Description copied from interface: FlinkAdminApi
      Convenient check if an catalog identified by hrn exists
      Specified by:
      checkIfCatalogExists in interface FlinkAdminApi
      Parameters:
      hrn - catalog identifier
      Returns:
      true if catalog exists, false otherwise

    • checkIfSubscriptionExists

      public Boolean checkIfSubscriptionExists(HRN hrn)
      Description copied from interface: FlinkAdminApi
      Convenient check if a subscription identified by hrn exists
      Specified by:
      checkIfSubscriptionExists in interface FlinkAdminApi
      Parameters:
      hrn - subscription identifier
      Returns:
      true if subscription exists, false otherwise

    • createCatalog

      public HRN createCatalog(WritableCatalogConfiguration configuration)
      Description copied from interface: FlinkAdminApi
      Creates new catalog.

      Specified by:
      createCatalog in interface FlinkAdminApi
      Parameters:
      configuration - The configuration of the catalog.
      Returns:
      The hrn of created catalog

    • deleteCatalog

      public void deleteCatalog(HRN hrn)
      Description copied from interface: FlinkAdminApi
      Delete a catalog.

      Deletes a catalog including its configuration.

      Specified by:
      deleteCatalog in interface FlinkAdminApi
      Parameters:
      hrn - The hrn of the catalog that should be deleted.

    • deleteLayer

      public void deleteLayer(HRN hrn, String layer)
      Description copied from interface: FlinkAdminApi
      Delete a layer.

      Deletes a layer from a catalog.

      Note: Versioned layers cannot be deleted.

      Specified by:
      deleteLayer in interface FlinkAdminApi
      Parameters:
      hrn - The HERE Resource Name (HRN) of the catalog that contains the layer you want to delete.
      layer - The ID of the layer.

    • getConfiguration

      public CatalogConfiguration getConfiguration(HRN hrn)
      Description copied from interface: FlinkAdminApi
      Get configuration of a catalog.

      Specified by:
      getConfiguration in interface FlinkAdminApi
      Parameters:
      hrn - The hrn of the catalog that should be returned.
      Returns:
      configuration of a catalog

    • getSubscriptionConfiguration

      public SubscriptionConfiguration getSubscriptionConfiguration(HRN hrn)
      Description copied from interface: FlinkAdminApi
      Gets the configuration of the subscription associated with the HRN.
      Specified by:
      getSubscriptionConfiguration in interface FlinkAdminApi
      Parameters:
      hrn - The HERE Resource Name (HRN) of subscription
      Returns:
      the configuration of the subscription

    • listCatalogs

      public List<HRN> listCatalogs()
      Description copied from interface: FlinkAdminApi
      Return list of catalog HRNs
      Specified by:
      listCatalogs in interface FlinkAdminApi
      Returns:
      list of catalog HRNs

    • listCatalogs

      public org.apache.flink.api.connector.source.Source<CatalogConfiguration,? extends org.apache.flink.api.connector.source.SourceSplit,?> listCatalogs(ListCatalogsParams params)
      Description copied from interface: FlinkAdminApi
      Return list of catalog configurations that match the given filter
      Specified by:
      listCatalogs in interface FlinkAdminApi
      Returns:
      list of catalog configurations

    • listSubscriptions

      public org.apache.flink.api.connector.source.Source<SubscriptionConfiguration,? extends org.apache.flink.api.connector.source.SourceSplit,?> listSubscriptions(OptionalInt limit)
      Description copied from interface: FlinkAdminApi
      Return list of all subscriptions that your account has access to
      Specified by:
      listSubscriptions in interface FlinkAdminApi
      Parameters:
      limit - Optional number of maximum elements in subscription list response.
      Returns:
      list of subscription configurations

    • subscribe

      public HRN subscribe(WritableSubscriptionConfiguration configuration)
      Description copied from interface: FlinkAdminApi
      Creates a subscription between source catalog/layer and target catalog/layer.
      Specified by:
      subscribe in interface FlinkAdminApi
      Parameters:
      configuration - The configuration of the subscription.
      Returns:
      the HERE Resource Name (HRN) of the newly created subscription

    • unsubscribe

      public void unsubscribe(HRN hrn)
      Description copied from interface: FlinkAdminApi
      Deletes a subscription associated with the HRN.
      Specified by:
      unsubscribe in interface FlinkAdminApi
      Parameters:
      hrn - The HERE Resource Name (HRN) of subscription

    • updateConfiguration

      public void updateConfiguration(WritableCatalogConfiguration configuration)
      Description copied from interface: FlinkAdminApi
      Update configuration of a catalog.

      Specified by:
      updateConfiguration in interface FlinkAdminApi
      Parameters:
      configuration - The configuration of the catalog. If set the version property should match current configuration version plus one.