trait PublishApi extends AnyRef
Publish partition metadata to a catalog.
- Alphabetic
- By Inheritance
- PublishApi
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
cancelBatch(token: BatchToken): Future[Done]
Cancels a batch operation.
Cancels a batch operation.
Cancels an active batch and signals that submitted batch publications can be discarded. The token will no longer be valid after cancel batch operation.
- token
Token retrieved from a function com.here.platform.data.client.scaladsl.PublishApi.startBatch2.
- returns
future which completes when batch is fully cancelled by the server.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
completeBatch(token: BatchToken): Future[Done]
Finalizes the batch and waits until the metadata has been processed.
Finalizes the batch and waits until the metadata has been processed.
- token
Token retrieved from a function com.here.platform.data.client.scaladsl.PublishApi.startBatch2.
- returns
future which completes when publication is fully processed by server and new version is published to catalog or when the processing failed.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
deleteFeatureChanges(layerId: String, versionQuery: VersionQuery): Future[Done]
Deletes one or more changesets where the version number can be specified by the query parameter 'versionQuery'.
Deletes one or more changesets where the version number can be specified by the query parameter 'versionQuery'. The service will begin the process to remove the versions from version 9 until the version 0. During the deletion process, newer versions can be created and won't be affected.
- layerId
layerId of interactive Map layer. If the layer specified in request does not exist, an error is returned.
- versionQuery
The query parameter used to specify the versions to be deleted. The value must be an integer, bigger than 0 and the comparator should be one of the below list:
- <
- =lt=
i.e:
version=lt=10orversion<10
- returns
future which completes when deletion is fully processed by server
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable errorjava.lang.IllegalArgumentExceptionif the layer does not exist
-
abstract
def
deleteFeatures(layer: String, ids: Seq[String], context: Option[InteractiveMapContext] = None): Future[FeatureCollection]
Deletes specified features from Interactive Map layer.
Deletes specified features from Interactive Map layer.
- layer
Name of interactive Map layer. If the layer specified in request does not exist, an error is returned.
- ids
List of feature IDs to be deleted
- context
The context where the operation will be performed on a composite layer. If not specified, the operation occurs based on the extension rules.
- returns
Future which completes when specified featureCollection is uploaded.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
deleteIndex(layer: String, queryString: String): Future[String]
Deletes the partitions from index layer that match the provided query written in the RSQL query language.
Deletes the partitions from index layer that match the provided query written in the RSQL query language.
- layer
Name of the index layer. If the layer specified in request does not exist, an error is returned.
- queryString
String written in the RSQL query language to query the index layer
- returns
Delete request id which can be used to query the delete status.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
getBaseVersion(): Future[Option[Long]]
Get latest version available for the given catalog which can be used in com.here.platform.data.client.scaladsl.PublishApi.startBatch2.
Get latest version available for the given catalog which can be used in com.here.platform.data.client.scaladsl.PublishApi.startBatch2.
- returns
Returns Some(version) - latest version for the given catalog. If the catalog doesn't contain any versions None will be returned.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
patchFeature(layer: String, feature: Feature, featureId: String): Future[Feature]
Patch specified feature in Interactive Map layer.
Patch specified feature in Interactive Map layer.
- layer
Name of interactive Map layer. If the layer specified in request does not exist, an error is returned.
- feature
The feature to put in Interactive Map layer.
- featureId
The feature ID of the feature.
- returns
Future which completes when specified feature is patched.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
patchFeatureJson(layer: String, feature: String, featureId: String): Future[String]
Patch specified feature in Interactive Map layer.
Patch specified feature in Interactive Map layer.
- layer
Name of interactive Map layer. If the layer specified in request does not exist, an error is returned.
- feature
The feature to put in Interactive Map layer.
- featureId
The feature ID of the feature.
- returns
Future which completes when specified feature is patched.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
postFeatureCollection(layer: String, featureCollection: FeatureCollection, ifExist: Option[IfExistType] = Some(IfExistType.PATCH), ifNotExist: Option[IfNotExistType] = Some(IfNotExistType.CREATE), transactional: Boolean = true): Future[FeatureCollection]
Uploads specified FeatureCollection to Interactive Map layer.
Uploads specified FeatureCollection to Interactive Map layer.
- layer
Name of interactive Map layer. If the layer specified in request does not exist, an error is returned.
- featureCollection
The FeatureCollection to put in Interactive Map layer.
- ifExist
The action to execute, when a feature with the provided ID exists. Default is PATCH.
- ifNotExist
The action to execute, when a feature with the provided ID does not exist or the feature contains no ID. Default is CREATE.
- transactional
Defines, if this is a transactional operation. Default is true.
- returns
Future which completes when specified featureCollection is uploaded.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
postFeatureCollectionJson(layer: String, featureCollection: String, ifExist: Option[IfExistType], ifNotExist: Option[IfNotExistType], transactional: Boolean = true): Future[String]
Uploads specified FeatureCollection to Interactive Map layer.
Uploads specified FeatureCollection to Interactive Map layer.
- layer
Name of interactive Map layer. If the layer specified in request does not exist, an error is returned.
- featureCollection
The FeatureCollection to put in Interactive Map layer.
- ifExist
The action to execute, when a feature with the provided ID exists. Default is PATCH.
- ifNotExist
The action to execute, when a feature with the provided ID does not exist or the feature contains no ID. Default is CREATE.
- transactional
Defines, if this is a transactional operation. Default is true.
- returns
Future which completes when specified featureCollection is uploaded.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
postFeatureModifications(layer: String, featureModificationList: FeatureModificationList, transactional: Boolean = true): Future[FeatureCollection]
Uploads FeatureCollection(s) specified in FeatureModificationList to Interactive Map layer.
Uploads FeatureCollection(s) specified in FeatureModificationList to Interactive Map layer.
- layer
Name of interactive Map layer. If the layer specified in request does not exist, an error is returned.
- featureModificationList
The FeatureModificationList which contains list of features that need to get created/updated/deleted in Interactive Map layer.
- transactional
Defines, if this is a transactional operation. Default is true.
- returns
Future which completes when specified FeatureCollection(s) are uploaded.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
postFeatureModificationsJson(layer: String, featureModificationList: String, transactional: Boolean = true): Future[String]
Uploads FeatureCollection(s) specified in FeatureModificationList to Interactive Map layer.
Uploads FeatureCollection(s) specified in FeatureModificationList to Interactive Map layer.
- layer
Name of interactive Map layer. If the layer specified in request does not exist, an error is returned.
- featureModificationList
The FeatureModificationList which contains list of features that need to get created/updated/deleted in Interactive Map layer.
- transactional
Defines, if this is a transactional operation. Default is true.
- returns
Future which completes when specified FeatureCollection(s) are uploaded.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
publishBatch2(baseVersion: Option[Long], layerIds: Option[Seq[String]], dependencies: Seq[VersionDependency], partitions: Source[CommitPartition, NotUsed]): Future[Done]
Performs new batch publication to a catalog.
Performs new batch publication to a catalog.
Data for CommitPartition must be already uploaded beforehand
This call is identical to com.here.platform.data.client.scaladsl.PublishApi.startBatch2 + com.here.platform.data.client.scaladsl.PublishApi.publishToBatch(token:com\.here\.platform\.data\.client\.model\.BatchToken,partitions:akka\.stream\.scaladsl\.Source* + com.here.platform.data.client.scaladsl.PublishApi.completeBatch.
Please note that there can only be one active publication at a time per versioned layer.- baseVersion
This parameter is deprecated and not used anymore.
- layerIds
List of layer ids which should be updated. Note: Publishing versioned and volatile layer partitions in the same publication is not advisable as in this case it increases version number even for volatile layers.
- dependencies
List of the dependencies for this publication. This is only relevant for publishing to versioned layer.
- partitions
partitions to publish.
- returns
future which completes when publication is fully processed by server and new version is published to 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
publishBatch2(baseVersion: Option[Long], layerIds: Option[Seq[String]], dependencies: Seq[VersionDependency], partitions: Iterator[CommitPartition]): Future[Done]
Performs new batch publication to a catalog.
Performs new batch publication to a catalog.
Data for CommitPartition must be already uploaded beforehand
This call is identical to com.here.platform.data.client.scaladsl.PublishApi.startBatch2 + com.here.platform.data.client.scaladsl.PublishApi.publishToBatch(token:com\.here\.platform\.data\.client\.model\.BatchToken,partitions:Iterator* + com.here.platform.data.client.scaladsl.PublishApi.completeBatch.
Please note that there can only be one active publication at a time per versioned layer.- baseVersion
This parameter is deprecated and not used anymore.
- layerIds
List of layer ids which should be updated. Note: Publishing versioned and volatile layer partitions in the same publication is not advisable as in this case it increases version number even for volatile layers.
- dependencies
List of the dependencies for this publication. This is only relevant for publishing to versioned layer.
- partitions
partitions to publish.
- returns
future which completes when publication is fully processed by server and new version is published to 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
publishIndex(layer: String, partitions: Source[CommitPartition, NotUsed]): Future[Done]
Performs indexing of the specified partitions in Index layer.
Performs indexing of the specified partitions in Index layer.
The partitions are indexed using the specified index keys defined in each indexing partition. After indexing the partitions can be searched by keys using query method from Query API. Note that partition will be overwritten if it already indexed.
- layer
Name of index layer. If the layer specified in request does not exist, an error is returned.
- partitions
The partitions to index.
- returns
Future which completes when specified partitions are indexed.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
publishIndex(layer: String, partitions: Iterator[CommitPartition]): Future[Done]
Performs indexing of the specified partitions in Index layer.
Performs indexing of the specified partitions in Index layer.
The partitions are indexed using the specified index keys defined in each indexing partition. After indexing the partitions can be searched by keys using query method from Query API. Note that partition will be overwritten if it already indexed.
- layer
Name of index layer. If the layer specified in request does not exist, an error is returned.
- partitions
The partitions to index.
- returns
Future which completes when specified partitions are indexed.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
publishToBatch(token: BatchToken, partitions: Source[CommitPartition, NotUsed]): Future[Done]
Upload partitions for given commit token.
Upload partitions for given commit token.
- token
Token retrieved from a function com.here.platform.data.client.scaladsl.PublishApi.startBatch2.
- partitions
partitions to upload.
- returns
future which completes when all partitions are uploaded to server.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
publishToBatch(token: BatchToken, partitions: Iterator[CommitPartition]): Future[Done]
Upload partitions for given commit token.
Upload partitions for given commit token.
- token
Token retrieved from a function com.here.platform.data.client.scaladsl.PublishApi.startBatch2.
- partitions
partitions to upload.
- returns
future which completes when all partitions are uploaded to server.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
putFeature(layer: String, feature: Feature, featureId: String): Future[Feature]
Uploads specified feature to Interactive Map layer.
Uploads specified feature to Interactive Map layer.
- layer
Name of interactive Map layer. If the layer specified in request does not exist, an error is returned.
- feature
The feature to put in Interactive Map layer.
- featureId
The feature ID of the feature.
- returns
Future which completes when specified feature is uploaded.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
putFeatureCollection(layer: String, featureCollection: FeatureCollection): Future[FeatureCollection]
Uploads specified FeatureCollection to Interactive Map layer.
Uploads specified FeatureCollection to Interactive Map layer.
- layer
Name of interactive Map layer. If the layer specified in request does not exist, an error is returned.
- featureCollection
The FeatureCollection to put in Interactive Map layer.
- returns
Future which completes when specified featureCollection is uploaded.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
putFeatureCollectionJson(layer: String, featureCollection: String): Future[String]
Uploads specified FeatureCollection to Interactive Map layer.
Uploads specified FeatureCollection to Interactive Map layer.
- layer
Name of interactive Map layer. If the layer specified in request does not exist, an error is returned.
- featureCollection
The FeatureCollection to put in Interactive Map layer.
- returns
Future which completes when specified featureCollection is uploaded.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
putFeatureJson(layer: String, feature: String, featureId: String): Future[String]
Uploads specified feature to Interactive Map layer.
Uploads specified feature to Interactive Map layer.
- layer
Name of interactive Map layer. If the layer specified in request does not exist, an error is returned.
- feature
The feature to put in Interactive Map layer.
- featureId
The feature ID of the feature.
- returns
Future which completes when specified feature is uploaded.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
setMinimumVersion(minimumVersion: Long): Future[Done]
Sets the new minimum version for a catalog with versioned layers.
Sets the new minimum version for a catalog with versioned layers.
This removes all catalog versions that are older than the specified version.
- minimumVersion
The new version that will become a catalog's minimum version.
- returns
Future which completes when the value has been set.
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
startBatch2(baseVersion: Option[Long], layerIds: Option[Seq[String]], dependencies: Seq[VersionDependency] = Seq.empty): Future[BatchToken]
Starts a new batch for a catalog with layers explicitly named.
Starts a new batch for a catalog with layers explicitly named.
This call is used to start a new publishing to a catalog. The layers must be named explicitly. The returned token is valid for 24 hours.
Please note that there can only be one active publication at a time per versioned layer.- baseVersion
This parameter is deprecated and not used anymore.
- layerIds
List of layer ids which should be updated. Note: Publishing versioned and volatile layer partitions in the same publication is not advisable as in this case it increases version number even for volatile layers.
- dependencies
List of the dependencies for this publication. This is only relevant for publishing to versioned layer.
- returns
The token to use in subsequent calls that are part of the same publication (e.g.com.here.platform.data.client.scaladsl.PublishApi.publishToBatch(token:com\.here\.platform\.data\.client\.model\.BatchToken,partitions:Iterator*).
- Exceptions thrown
com.here.platform.data.client.DataClientNonRetriableExceptionin case of non-retriable errorcom.here.platform.data.client.DataClientRetriableExceptionin case of retriable error
-
abstract
def
updateIndex(layer: String, additions: Source[CommitPartition, NotUsed], removals: Source[CommitPartition, NotUsed]): Future[Done]
Updates an index layer by adding the
additionspartitions and removingremovalspartitions.Updates an index layer by adding the
additionspartitions and removingremovalspartitions.- layer
Name of the index layer. If the layer specified in request does not exist, an error is returned.
- additions
The partitions to add to the index.
- removals
The partitions to remove from the index.
- returns
Future which completes when additions are added and removals are 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
updateIndex(layer: String, additions: Iterator[CommitPartition], removals: Iterator[CommitPartition]): Future[Done]
Updates an index layer by adding the
additionspartitions and removingremovalspartitions.Updates an index layer by adding the
additionspartitions and removingremovalspartitions.- layer
Name of the index layer. If the layer specified in request does not exist, an error is returned.
- additions
The partitions to add to the index.
- removals
The partitions to remove from the index.
- returns
Future which completes when additions are added and removals are removed.
- 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()