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

Interface AdminApi

public interface AdminApi

Maintain catalogs and their configuration.

Method Summary

Modifier and Type	Method	Description
CompletionStage<Boolean>	checkIfCatalogExists(HRN hrn)	Convenient check if an catalog identified by hrn exists
CompletionStage<Boolean>	checkIfSubscriptionExists(HRN hrn)	Convenient check if a subscription identified by hrn exists
CompletionStage<HRN>	createCatalog(WritableCatalogConfiguration configuration)	Creates new catalog.
CompletionStage<org.apache.pekko.Done>	deleteCatalog(HRN hrn)	Delete a catalog.
CompletionStage<org.apache.pekko.Done>	deleteLayer(HRN hrn, String layer)	Delete a layer.
CompletionStage<CatalogConfiguration>	getConfiguration(HRN hrn)	Get configuration of a catalog.
CompletionStage<SubscriptionConfiguration>	getSubscriptionConfiguration(HRN hrn)	Gets the configuration of the subscription associated with the HRN.
CompletionStage<List<HRN>>	listCatalogs()	Return list of catalog HRNs
CompletionStage<Iterator<CatalogConfiguration>>	listCatalogs(ListCatalogsParams params)	Return list of catalog configurations that match the given filter
CompletionStage<Iterator<SubscriptionConfiguration>>	listSubscriptions()	Return list of all subscriptions that your account has access to
CompletionStage<Iterator<SubscriptionConfiguration>>	listSubscriptions(OptionalInt limit)	Return list of all subscriptions that your account has access to
CompletionStage<org.apache.pekko.Done>	removeAutomaticVersionDeletion(HRN hrn)	Remove the automatic version deletion configuration of a catalog.
CompletionStage<HRN>	subscribe(WritableSubscriptionConfiguration configuration)	Creates a subscription between source catalog/layer and target catalog/layer.
CompletionStage<org.apache.pekko.Done>	unsubscribe(HRN hrn)	Deletes a subscription associated with the HRN.
CompletionStage<org.apache.pekko.Done>	updateConfiguration(WritableCatalogConfiguration configuration)	Update configuration of a catalog.
CompletionStage<org.apache.pekko.Done>	updateLayer(HRN hrn, String layerId, UpdatableLayer layer)	Update a layer.

Method Details

checkIfCatalogExists

CompletionStage<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

CompletionStage<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

CompletionStage<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

CompletionStage<org.apache.pekko.Done> 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

CompletionStage<org.apache.pekko.Done> 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

CompletionStage<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

CompletionStage<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

CompletionStage<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

CompletionStage<Iterator<CatalogConfiguration>> 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

CompletionStage<Iterator<SubscriptionConfiguration>> listSubscriptions()

Return list of all subscriptions that your account has access to

Returns:

list of subscription configurations

Throws:

DataClientNonRetriableException - in case of non-retriable error

DataClientRetriableException - in case of retriable error

listSubscriptions

CompletionStage<Iterator<SubscriptionConfiguration>> 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

removeAutomaticVersionDeletion

CompletionStage<org.apache.pekko.Done> removeAutomaticVersionDeletion(HRN hrn)

Remove the automatic version deletion configuration of a catalog.

Prior catalog versions will no longer be deleted automatically.

Parameters:

hrn - The HERE Resource Name (HRN) of the catalog where automatic version deletion is removed.

Returns:

future stage which completes when the automatic version deletion configuration is removed.

Throws:

DataClientNonRetriableException - in case of non-retriable error

DataClientRetriableException - in case of retriable error

subscribe

CompletionStage<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

CompletionStage<org.apache.pekko.Done> 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

CompletionStage<org.apache.pekko.Done> 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

updateLayer

CompletionStage<org.apache.pekko.Done> updateLayer(HRN hrn,
 String layerId,
 UpdatableLayer layer)

Update a layer.

Parameters:

hrn - The HERE Resource Name (HRN) of the catalog where automatic version deletion is removed.

layerId - The ID of the layer.

layer - The updated model.

Throws:

DataClientNonRetriableException - in case of non-retriable error

DataClientRetriableException - in case of retriable error