trait AdminApi extends AnyRef
Maintain catalogs and their configuration.
- Alphabetic
- By Inheritance
- AdminApi
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
checkIfCatalogExists(hrn: HRN): Future[Boolean]
Convenient check if an catalog identified by hrn exists in data service
Convenient check if an catalog identified by hrn exists in data service
- hrn
catalog identifier
- returns
true if catalog exists, false otherwise
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
checkIfSubscriptionExists(hrn: HRN): Future[Boolean]
Convenient check if a subscription identified by hrn exists
Convenient check if a subscription identified by hrn exists
- hrn
The HERE Resource Name (HRN) of subscription
- returns
true if subscription exists, false otherwise
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
createCatalog(configuration: WritableCatalogConfiguration): Future[HRN]
Creates new catalog.
Creates new catalog.
- configuration
The configuration of the catalog.
- returns
The hrn of created catalog
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
deleteCatalog(hrn: HRN): Future[Done]
Delete a catalog.
Delete a catalog.
Deletes a catalog including its configuration.
- hrn
The hrn of the catalog that should be deleted.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
deleteLayer(hrn: HRN, layer: String): Future[Done]
Delete a layer.
Delete a layer.
Deletes a layer from a catalog.
Note: Versioned layers cannot be deleted.
- hrn
The HERE Resource Name (HRN) of the catalog that contains the layer you want to delete.
- layer
The ID of the layer.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getConfiguration(hrn: HRN): Future[CatalogConfiguration]
Get configuration of a catalog.
Get configuration of a catalog.
- hrn
The hrn of the catalog that should be returned.
- returns
configuration of a catalog
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getSubscriptionConfiguration(hrn: HRN): Future[SubscriptionConfiguration]
Gets the configuration of the subscription associated with the HRN.
Gets the configuration of the subscription associated with the HRN.
- hrn
The HERE Resource Name (HRN) of subscription
- returns
the configuration of the subscription
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getSubset(hrn: HRN, subsetId: String): Future[CatalogSubset]
Get the details of a subset
Get the details of a subset
- hrn
The HERE Resource Name (HRN) of the catalog
- subsetId
The subset ID.
- returns
details of a subset
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getSubsets(hrn: HRN, limit: Option[Int] = None, areas: Option[Seq[String]] = None): Future[Seq[CatalogSubset]]
Get the list of all accessible subsets which match the optional areaId filter
Get the list of all accessible subsets which match the optional areaId filter
- hrn
The HERE Resource Name (HRN) of the catalog
- limit
Optional number of maximum elements in subsets list response.
- areas
Optional list of areaIds which is used to filter the subsets list response.
- returns
list of subsets
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getSubsetsAsSource(hrn: HRN, limit: Option[Int] = None, areas: Option[Seq[String]] = None): Future[Source[CatalogSubset, NotUsed]]
Get the list of all accessible subsets which match the optional areaId filter
Get the list of all accessible subsets which match the optional areaId filter
- hrn
The HERE Resource Name (HRN) of the catalog
- limit
Optional number of maximum elements in subsets list response.
- areas
Optional list of areaIds which is used to filter the subsets list response.
- returns
list of subsets as a Akka Source
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getSubsetsFingerprint(hrn: HRN): Future[CatalogSubsetsFingerprint]
Get a fingerprint that represents the accessible subset configuration
Get a fingerprint that represents the accessible subset configuration
- hrn
The HERE Resource Name (HRN) of the catalog
- returns
subsets fingerprint
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
listCatalogs(params: ListCatalogsParams): Future[Source[CatalogConfiguration, NotUsed]]
Return list of catalog configurations that match the given filter
Return list of catalog configurations that match the given filter
- returns
list of catalog configurations
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
listCatalogs(): Future[Seq[HRN]]
Return list of catalog HRNs
Return list of catalog HRNs
- returns
list of catalog HRNs
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
listSubscriptions(limit: Option[Int] = None): Future[Seq[SubscriptionConfiguration]]
Return list of all subscriptions that your account has access to as an immutable sequence
Return list of all subscriptions that your account has access to as an immutable sequence
- limit
Optional number of maximum elements in subscription list response.
- returns
list of subscription configurations
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
listSubscriptionsAsSource(limit: Option[Int] = None): Future[Source[SubscriptionConfiguration, NotUsed]]
Return list of all subscriptions that your account has access to as an Akka Source
Return list of all subscriptions that your account has access to as an Akka Source
- limit
Optional number of maximum elements in subscription list response.
- returns
list of subscription configurations
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
removeAutomaticVersionDeletion(hrn: HRN): Future[Done]
Remove the automatic version deletion configuration of a catalog.
Remove the automatic version deletion configuration of a catalog.
Prior catalog versions will no longer be deleted automatically.
- 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.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
subscribe(configuration: WritableSubscriptionConfiguration): Future[HRN]
Creates a subscription between source catalog/layer and target catalog/layer.
Creates a subscription between source catalog/layer and target catalog/layer.
- configuration
The configuration of the subscription.
- returns
the HERE Resource Name (HRN) of the newly created subscription
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
unsubscribe(hrn: HRN): Future[Done]
Deletes a subscription associated with the HRN.
Deletes a subscription associated with the HRN.
- hrn
The HERE Resource Name (HRN) of subscription
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
updateConfiguration(configuration: WritableCatalogConfiguration): Future[Done]
Update configuration of a catalog.
Update configuration of a catalog.
- configuration
The configuration of the catalog. If catalog exists will overwrite any previous existing configuration. If set the version property should match current configuration version plus one.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
updateLayer(hrn: HRN, layerId: String, layer: UpdatableLayer): Future[Done]
Update a layer.
Update a layer.
- 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.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()