Packages

trait FlinkAdminApi extends AnyRef

Maintain catalogs and their configuration.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FlinkAdminApi
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def checkIfCatalogExists(hrn: HRN): 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.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

  2. abstract def checkIfSubscriptionExists(hrn: HRN): Boolean

    Convenient check if a subscription identified by hrn exists

    Convenient check if a subscription identified by hrn exists

    hrn

    subscription identifier

    returns

    true if subscription exists, false otherwise

    Exceptions thrown

    com.here.platform.data.client.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

  3. abstract def createCatalog(configuration: WritableCatalogConfiguration): 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.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

  4. abstract def deleteCatalog(hrn: HRN): Unit

    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.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

  5. abstract def deleteLayer(hrn: HRN, layer: String): Unit

    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.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

  6. abstract def getConfiguration(hrn: HRN): 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.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

  7. abstract def getSubscriptionConfiguration(hrn: HRN): 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.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

  8. abstract def listCatalogs(params: ListCatalogsParams): SourceFunction[CatalogConfiguration]

    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.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

  9. abstract def listCatalogs(): Seq[HRN]

    Return list of catalog HRNs

    Return list of catalog HRNs

    returns

    list of catalog HRNs

    Exceptions thrown

    com.here.platform.data.client.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

  10. abstract def listSubscriptions(limit: Option[Int] = None): SourceFunction[SubscriptionConfiguration]

    Return list of all subscriptions that your account has access to

    Return list of all subscriptions that your account has access to

    limit

    Optional number of maximum elements in subscription list response.

    returns

    list of subscription configurations

    Exceptions thrown

    com.here.platform.data.client.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

  11. abstract def subscribe(configuration: WritableSubscriptionConfiguration): 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.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

  12. abstract def unsubscribe(hrn: HRN): Unit

    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.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

  13. abstract def updateConfiguration(configuration: WritableCatalogConfiguration): Unit

    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.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped