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

Interface FlinkAdminApi

All Known Implementing Classes:

FlinkAdminApiImpl

public interface FlinkAdminApi

Maintain catalogs and their configuration.

Method Summary

Modifier and Type	Method	Description
Boolean	checkIfCatalogExists(HRN hrn)	Convenient check if an catalog identified by hrn exists
Boolean	checkIfSubscriptionExists(HRN hrn)	Convenient check if a subscription identified by hrn exists
HRN	createCatalog(WritableCatalogConfiguration configuration)	Creates new catalog.
void	deleteCatalog(HRN hrn)	Delete a catalog.
void	deleteLayer(HRN hrn, String layer)	Delete a layer.
CatalogConfiguration	getConfiguration(HRN hrn)	Get configuration of a catalog.
SubscriptionConfiguration	getSubscriptionConfiguration(HRN hrn)	Gets the configuration of the subscription associated with the HRN.
List<HRN>	listCatalogs()	Return list of catalog HRNs
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
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
HRN	subscribe(WritableSubscriptionConfiguration configuration)	Creates a subscription between source catalog/layer and target catalog/layer.
void	unsubscribe(HRN hrn)	Deletes a subscription associated with the HRN.
void	updateConfiguration(WritableCatalogConfiguration configuration)	Update configuration of a catalog.

Method Details

checkIfCatalogExists

Boolean checkIfCatalogExists(HRN hrn)

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 error

DataClientRetriableException - in case of retriable error

checkIfSubscriptionExists

Boolean checkIfSubscriptionExists(HRN hrn)

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 error

DataClientRetriableException - in case of retriable error

createCatalog

HRN createCatalog(WritableCatalogConfiguration configuration)

Creates new catalog.

Parameters:

configuration - The configuration of the catalog.

Returns:

The hrn of created catalog

Throws:

DataClientNonRetriableException - in case of non-retriable error

DataClientRetriableException - in case of retriable error

deleteCatalog

void deleteCatalog(HRN hrn)

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 error

DataClientRetriableException - in case of retriable error

deleteLayer

void deleteLayer(HRN hrn,
 String layer)

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 error

DataClientRetriableException - in case of retriable error

getConfiguration

CatalogConfiguration getConfiguration(HRN hrn)

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 error

DataClientRetriableException - in case of retriable error

getSubscriptionConfiguration

SubscriptionConfiguration getSubscriptionConfiguration(HRN hrn)

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 error

DataClientRetriableException - in case of retriable error

listCatalogs

List<HRN> listCatalogs()

Return list of catalog HRNs

Returns:

list of catalog HRNs

Throws:

DataClientNonRetriableException - in case of non-retriable error

DataClientRetriableException - 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 error

DataClientRetriableException - 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 error

DataClientRetriableException - in case of retriable error

subscribe

HRN subscribe(WritableSubscriptionConfiguration configuration)

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 error

DataClientRetriableException - in case of retriable error

unsubscribe

void unsubscribe(HRN hrn)

Deletes a subscription associated with the HRN.

Parameters:

hrn - The HERE Resource Name (HRN) of subscription

Throws:

DataClientNonRetriableException - in case of non-retriable error

DataClientRetriableException - in case of retriable error

updateConfiguration

void updateConfiguration(WritableCatalogConfiguration configuration)

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 error

DataClientRetriableException - in case of retriable error