Interface FlinkAdminApi
- All Known Implementing Classes:
FlinkAdminApiImpl
public interface FlinkAdminApi
Maintain catalogs and their configuration.
-
Method Summary
Modifier and TypeMethodDescriptioncheckIfCatalogExists(HRN hrn) Convenient check if an catalog identified by hrn existsConvenient check if a subscription identified by hrn existscreateCatalog(WritableCatalogConfiguration configuration) Creates new catalog.voiddeleteCatalog(HRN hrn) Delete a catalog.voiddeleteLayer(HRN hrn, String layer) Delete a layer.getConfiguration(HRN hrn) Get configuration of a catalog.Gets the configuration of the subscription associated with the HRN.Return list of catalog HRNsorg.apache.flink.api.connector.source.Source<CatalogConfiguration,? extends org.apache.flink.api.connector.source.SourceSplit, ?> listCatalogs(ListCatalogsParams params) Return list of catalog configurations that match the given filterorg.apache.flink.api.connector.source.Source<SubscriptionConfiguration,? extends org.apache.flink.api.connector.source.SourceSplit, ?> listSubscriptions(OptionalInt limit) Return list of all subscriptions that your account has access tosubscribe(WritableSubscriptionConfiguration configuration) Creates a subscription between source catalog/layer and target catalog/layer.voidunsubscribe(HRN hrn) Deletes a subscription associated with the HRN.voidupdateConfiguration(WritableCatalogConfiguration configuration) Update configuration of a catalog.
-
Method Details
-
checkIfCatalogExists
Convenient check if an catalog identified by hrn exists- Parameters:
hrn- catalog identifier- Returns:
- true if catalog exists, false otherwise
- Throws:
DataClientNonRetriableException- in case of non-retriable errorDataClientRetriableException- in case of retriable error
-
checkIfSubscriptionExists
Convenient check if a subscription identified by hrn exists- Parameters:
hrn- subscription identifier- Returns:
- true if subscription exists, false otherwise
- Throws:
DataClientNonRetriableException- in case of non-retriable errorDataClientRetriableException- in case of retriable error
-
createCatalog
Creates new catalog.- Parameters:
configuration- The configuration of the catalog.- Returns:
- The hrn of created catalog
- Throws:
DataClientNonRetriableException- in case of non-retriable errorDataClientRetriableException- in case of retriable error
-
deleteCatalog
Delete a catalog.Deletes a catalog including its configuration.
- Parameters:
hrn- The hrn of the catalog that should be deleted.- Throws:
DataClientNonRetriableException- in case of non-retriable errorDataClientRetriableException- in case of retriable error
-
deleteLayer
Delete a layer.Deletes a layer from a catalog.
Note: Versioned layers cannot be deleted.
- Parameters:
hrn- The HERE Resource Name (HRN) of the catalog that contains the layer you want to delete.layer- The ID of the layer.- Throws:
DataClientNonRetriableException- in case of non-retriable errorDataClientRetriableException- in case of retriable error
-
getConfiguration
Get configuration of a catalog.- Parameters:
hrn- The hrn of the catalog that should be returned.- Returns:
- configuration of a catalog
- Throws:
DataClientNonRetriableException- in case of non-retriable errorDataClientRetriableException- in case of retriable error
-
getSubscriptionConfiguration
Gets the configuration of the subscription associated with the HRN.- Parameters:
hrn- The HERE Resource Name (HRN) of subscription- Returns:
- the configuration of the subscription
- Throws:
DataClientNonRetriableException- in case of non-retriable errorDataClientRetriableException- in case of retriable error
-
listCatalogs
Return list of catalog HRNs- Returns:
- list of catalog HRNs
- Throws:
DataClientNonRetriableException- in case of non-retriable errorDataClientRetriableException- in case of retriable error
-
listCatalogs
org.apache.flink.api.connector.source.Source<CatalogConfiguration,? extends org.apache.flink.api.connector.source.SourceSplit, listCatalogs?> (ListCatalogsParams params) Return list of catalog configurations that match the given filter- Returns:
- list of catalog configurations
- Throws:
DataClientNonRetriableException- in case of non-retriable errorDataClientRetriableException- in case of retriable error
-
listSubscriptions
org.apache.flink.api.connector.source.Source<SubscriptionConfiguration,? extends org.apache.flink.api.connector.source.SourceSplit, listSubscriptions?> (OptionalInt limit) Return list of all subscriptions that your account has access to- Parameters:
limit- Optional number of maximum elements in subscription list response.- Returns:
- list of subscription configurations
- Throws:
DataClientNonRetriableException- in case of non-retriable errorDataClientRetriableException- in case of retriable error
-
subscribe
Creates a subscription between source catalog/layer and target catalog/layer.- Parameters:
configuration- The configuration of the subscription.- Returns:
- the HERE Resource Name (HRN) of the newly created subscription
- Throws:
DataClientNonRetriableException- in case of non-retriable errorDataClientRetriableException- in case of retriable error
-
unsubscribe
Deletes a subscription associated with the HRN.- Parameters:
hrn- The HERE Resource Name (HRN) of subscription- Throws:
DataClientNonRetriableException- in case of non-retriable errorDataClientRetriableException- in case of retriable error
-
updateConfiguration
Update configuration of a catalog.- Parameters:
configuration- The configuration of the catalog. If set the version property should match current configuration version plus one.- Throws:
DataClientNonRetriableException- in case of non-retriable errorDataClientRetriableException- in case of retriable error
-