trait ConfigFacade extends ServiceFacadeWithDatabase with ServiceFacade[ConfigFacade]
The interface for the external API of the Config Service.
The Config Service is responsible for the management of configuration related to data import and transformation, including embedded custom apps and internal data sources such as registries and files.
- Alphabetic
- By Inheritance
- ConfigFacade
- ServiceFacade
- ServiceFacadeWithDatabase
- ServiceFacadeBase
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract val environment: String
- Definition Classes
- ServiceFacadeBase
- abstract def getCacheStatistics: Array[CacheStatistics]
- Definition Classes
- ServiceFacadeBase
- abstract def getConfiguration(tag: String): ConfigurationInfo
Gets the most recent version of each connection, source and pipeline restricted to a specific tag.
Gets the most recent version of each connection, source and pipeline restricted to a specific tag. For each unique id an untagged version may be included if no matching tag exists.
- tag
The tag to use as restriction.
- abstract def getConfiguration(includeDeleted: Boolean): ConfigurationInfo
Gets the most recent version of each connection, source and pipeline, including deleted.
Gets the most recent version of each connection, source and pipeline, including deleted.
- includeDeleted
Whether to include deleted entities.
- abstract def getConnection(id: String): ConnectionInfo
Gets the most recent version of a specific connection
Gets the most recent version of a specific connection
- id
The unique id of the connection
- abstract def getConnections(includeDeleted: Boolean = false): Array[ConnectionInfo]
Gets the most recent version of each connection.
Gets the most recent version of each connection.
- includeDeleted
Whether to include deleted connections.
- abstract def getConnections: Array[ConnectionInfo]
Gets the most recent version of each connection.
- abstract def getCustomApp(id: String): CustomAppInfo
Gets the most recent version of a specific custom app.
Gets the most recent version of a specific custom app.
- id
The unique id of the custom app.
- abstract def getCustomApps(includeDeleted: Boolean = false): Array[CustomAppInfo]
Gets the most recent version of each custom app, including deleted.
Gets the most recent version of each custom app, including deleted.
- includeDeleted
Whether to include deleted custom apps.
- abstract def getCustomFunction(id: String): CustomFunctionInfo
Gets the most recent version of a specific custom function
Gets the most recent version of a specific custom function
- id
The unique id of the custom function
- abstract def getCustomFunctions(includeDeleted: Boolean = false): Array[CustomFunctionInfo]
Gets the most recent version of each custom function, including deleted.
Gets the most recent version of each custom function, including deleted.
- includeDeleted
Whether to include deleted custom functions.
- abstract def getCustomModule(id: String): CustomModuleInfo
Gets the most recent version of a specific custom module
Gets the most recent version of a specific custom module
- id
The unique id of the custom module
- abstract def getCustomModules(includeDeleted: Boolean = false): Array[CustomModuleInfo]
Gets the most recent version of each custom module, including deleted.
Gets the most recent version of each custom module, including deleted.
- includeDeleted
Whether to include deleted custom modules.
- abstract def getCustomTransform(id: String): CustomTransformInfo
Gets the most recent version of a specific custom transform
Gets the most recent version of a specific custom transform
- id
The unique id of the custom transform
- abstract def getCustomTransforms(includeDeleted: Boolean = false): Array[CustomTransformInfo]
Gets the most recent version of each custom transform, including deleted.
Gets the most recent version of each custom transform, including deleted.
- includeDeleted
Whether to include deleted custom transforms.
- abstract def getDatabase(outputStream: OutputStream): Unit
- Definition Classes
- ServiceFacadeWithDatabase
- abstract def getDatabasePath: String
- Definition Classes
- ServiceFacadeWithDatabase
- abstract def getFile(id: String, tag: String): FileInfo
Gets the most recent version of a specific file restricted to a specific tag.
Gets the most recent version of a specific file restricted to a specific tag. An untagged version may be returned if no matching tag exists.
- id
The unique id of the file.
- tag
The tag to use as restriction.
- abstract def getFile(path: String, outputStream: OutputStream): Unit
- Definition Classes
- ServiceFacadeBase
- abstract def getFiles(tag: String, includeDeleted: Boolean = false): Array[FileInfo]
Gets the most recent version of each file restricted to a specific tag.
Gets the most recent version of each file restricted to a specific tag. For each unique id an untagged version may be included if no matching tag exists.
- tag
The tag to use as restriction.
- includeDeleted
Whether to include deleted files.
- abstract def getFiles: Array[FileInfo]
Gets the most recent version of each file.
- abstract def getLogLevel: String
- Definition Classes
- ServiceFacadeBase
- abstract def getPerformanceMetrics: PerformanceMetrics
- Definition Classes
- ServiceFacadeBase
- abstract def getPipeline(id: String, tag: String): PipelineInfo
Gets the most recent version of a specific pipeline restricted to a specific tag.
Gets the most recent version of a specific pipeline restricted to a specific tag. An untagged version may be returned if no matching tag exists.
- id
The unique id of the pipeline.
- tag
The tag to use as restriction.
- abstract def getPipelines(tag: String, includeDeleted: Boolean = false): Array[PipelineInfo]
Gets the most recent version of each pipeline restricted to a specific tag.
Gets the most recent version of each pipeline restricted to a specific tag. For each unique id an untagged version may be included if no matching tag exists.
- tag
The tag to use as restriction.
- includeDeleted
Whether to include deleted pipelines
- abstract def getPipelines: Array[PipelineInfo]
Gets the most recent version of each pipeline.
- abstract def getPlugins: PluginsInfo
Gets the most recent version of each custom function, transform and module.
- abstract def getRegistries(includeDeleted: Boolean = false): Array[RegistryInfo]
Gets the most recent version of each registry, including deleted.
Gets the most recent version of each registry, including deleted.
- includeDeleted
Whether to include deleted registries.
- abstract def getRegistry(id: String): RegistryInfo
Gets the most recent version of a specific registry.
Gets the most recent version of a specific registry.
- id
The unique id of the registry.
- abstract def getRegistryEntities(registryId: String, includeDeleted: Boolean = false): Array[RegistryEntityInfo]
Gets the most recent version of each registry entity for a specific registry.
Gets the most recent version of each registry entity for a specific registry.
- registryId
The unique id of the registry.
- includeDeleted
Whether to include deleted registry entities.
- abstract def getRegistryEntity(registryId: String, id: String): RegistryEntityInfo
Gets the most recent version of a specific registry entity for a specific registry.
Gets the most recent version of a specific registry entity for a specific registry.
- registryId
The unique id of the registry.
- id
The unique id of the registry entity.
- abstract def getResourceForFile(id: String, tag: String, outputStream: OutputStream, part: Option[String] = None): Unit
Gets the data content of a specific file with a specific tag.
Gets the data content of a specific file with a specific tag.
- id
The unique id of the file.
- tag
The tag to require.
- outputStream
The stream where the data is written.
- part
An optional identifier for a specific part of a zip file.
- abstract def getSource(id: String, tag: String): SourceInfo
Gets the most recent version of a specific source restricted to a specific tag.
Gets the most recent version of a specific source restricted to a specific tag. An untagged version may be returned if no matching tag exists.
- id
The unique id of the source.
- tag
The tag to use as restriction.
- abstract def getSources(tag: String, includeDeleted: Boolean = false): Array[SourceInfo]
Gets the most recent version of each source restricted to a specific tag.
Gets the most recent version of each source restricted to a specific tag. For each unique id an untagged version may be included if no matching tag exists.
- tag
The tag to use as restriction.
- includeDeleted
Whether to include deleted sources
- abstract def getSources: Array[SourceInfo]
Gets the most recent version of each source.
- abstract def getVersion: String
- Definition Classes
- ServiceFacadeBase
- abstract def getVersionForConnection(id: String, versionId: UUID): ConnectionInfo
Gets a specific version of a specific connection.
Gets a specific version of a specific connection.
- id
The unique id of the connection.
- versionId
The
UUIDfor the version.
- abstract def getVersionForCustomApp(id: String, version: UUID): CustomAppInfo
Gets a specific version of a specific custom app.
Gets a specific version of a specific custom app.
- id
The unique id of the custom app.
- version
The
UUIDfor the version.
- abstract def getVersionForCustomFunction(id: String, versionId: UUID): CustomFunctionInfo
Gets a specific version of a specific custom function.
Gets a specific version of a specific custom function.
- id
The unique id of the custom function.
- versionId
The
UUIDfor the version.
- abstract def getVersionForCustomModule(id: String, versionId: UUID): CustomModuleInfo
Gets a specific version of a specific custom module.
Gets a specific version of a specific custom module.
- id
The unique id of the custom module.
- versionId
The
UUIDfor the version.
- abstract def getVersionForCustomTransform(id: String, versionId: UUID): CustomTransformInfo
Gets a specific version of a specific custom transform.
Gets a specific version of a specific custom transform.
- id
The unique id of the custom transform.
- versionId
The
UUIDfor the version.
- abstract def getVersionForFile(id: String, versionId: UUID): FileInfo
Gets a specific version of a specific file.
Gets a specific version of a specific file.
- id
The unique id of the file.
- versionId
The
UUIDfor the version.
- abstract def getVersionForPipeline(id: String, versionId: UUID): PipelineInfo
Gets a specific version of a specific pipeline.
Gets a specific version of a specific pipeline.
- id
The unique id of the pipeline.
- versionId
The
UUIDfor the version.
- abstract def getVersionForRegistry(id: String, version: UUID): RegistryInfo
Gets a specific version of a specific registry.
Gets a specific version of a specific registry.
- id
The unique id of the registry.
- version
The
UUIDfor the version.
- abstract def getVersionForRegistryEntity(registryId: String, id: String, version: UUID): RegistryEntityInfo
Gets a specific version of a specific registry entity for a specific registry.
Gets a specific version of a specific registry entity for a specific registry.
- registryId
The unique id of the registry.
- id
The unique id of the registry entity.
- version
The
UUIDfor the version.
- abstract def getVersionForSource(id: String, versionId: UUID): SourceInfo
Gets a specific version of a specific source.
Gets a specific version of a specific source.
- id
The unique id of the source.
- versionId
The
UUIDfor the version.
- abstract def getVersionsForConnection(id: String): Array[ConnectionInfo]
Gets all versions of a specific connection
Gets all versions of a specific connection
- id
The unique id of the connection
- abstract def getVersionsForCustomApp(id: String): Array[CustomAppInfo]
Gets all versions of a specific custom app.
Gets all versions of a specific custom app.
- id
The unique id of the custom app.
- abstract def getVersionsForCustomFunction(id: String): Array[CustomFunctionInfo]
Gets all versions of a specific custom function
Gets all versions of a specific custom function
- id
The unique id of the custom function
- abstract def getVersionsForCustomModule(id: String): Array[CustomModuleInfo]
Gets all versions of a specific custom module
Gets all versions of a specific custom module
- id
The unique id of the custom module
- abstract def getVersionsForCustomTransform(id: String): Array[CustomTransformInfo]
Gets all versions of a specific custom transform
Gets all versions of a specific custom transform
- id
The unique id of the custom transform
- abstract def getVersionsForFile(id: String, tag: String): Array[FileInfo]
Gets all versions of a specific file with a specific tag.
Gets all versions of a specific file with a specific tag.
- id
The unique id of the file.
- tag
The tag to require.
- abstract def getVersionsForPipeline(id: String, tag: String): Array[PipelineInfo]
Gets all versions of a specific pipeline with a specific tag.
Gets all versions of a specific pipeline with a specific tag.
- id
The unique id of the pipeline.
- tag
The tag to require.
- abstract def getVersionsForRegistry(id: String): Array[RegistryInfo]
Gets all versions of a specific registry.
Gets all versions of a specific registry.
- id
The unique id of the registry.
- abstract def getVersionsForRegistryEntity(registryId: String, id: String): Array[RegistryEntityInfo]
Gets all versions of a specific registry entity for a specific registry.
Gets all versions of a specific registry entity for a specific registry.
- registryId
The unique id of the registry.
- id
The unique id of the registry entity.
- abstract def getVersionsForSource(id: String, tag: String): Array[SourceInfo]
Gets all versions of a specific source with a specific tag.
Gets all versions of a specific source with a specific tag.
- id
The unique id of the source.
- tag
The tag to require.
- abstract def isReady: Boolean
- Definition Classes
- ServiceFacadeBase
- abstract def postCachePurge(id: Option[String]): Unit
- Definition Classes
- ServiceFacadeBase
- abstract def postConfiguration(configuration: ConfigurationContent, validateOnly: Boolean): Unit
Creates new versions of a collection of connections, sources and pipelines.
Creates new versions of a collection of connections, sources and pipelines. The changes are validated in their entirety, and are only executed if validation succeeds.
- configuration
The ConfigurationContent containing the changes.
- validateOnly
A dry-run option to test that the changes are valid. Default is false.
- abstract def postCopyRegistryEntity(registryId: String, id: String): RegistryEntityContent
Creates a new registry entity copied from a specific registry entity.
Creates a new registry entity copied from a specific registry entity. The id of the copy is generated from
UUID.randomUUIDand a "(copy)" suffix is appended to the name.- registryId
The unique id of the registry.
- id
The unique id of the registry entity.
- abstract def postCustomApp(content: CustomAppContent): Unit
Creates a new version of a custom app with the specific content.
Creates a new version of a custom app with the specific content.
- content
The content of the new version.
- abstract def postDatabaseBackup(encryptionEnabled: Option[Boolean], encryptionMasterKeyIdentifier: Option[String], outputRepository: String = EnvironmentVariables.output_repository): Unit
- Definition Classes
- ServiceFacadeWithDatabase
- abstract def postDeleteForConnection(id: String, force: Boolean = false): Unit
Marks a specific connection as deleted.
Marks a specific connection as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the connection.
- force
Whether to force deletion even if it leaves one or more sources or pipelines invalid.
- abstract def postDeleteForCustomApp(id: String): Unit
Marks a specific custom app as deleted.
Marks a specific custom app as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the custom app.
- abstract def postDeleteForCustomFunction(id: String, force: Boolean = false): Unit
Marks a specific custom function as deleted.
Marks a specific custom function as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the custom function.
- force
Whether to force deletion even if it leaves one or more pipelines invalid.
- abstract def postDeleteForCustomModule(id: String, force: Boolean = false): Unit
Marks a specific custom module as deleted.
Marks a specific custom module as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the custom module.
- force
Whether to force deletion even if it leaves one or more pipelines invalid.
- abstract def postDeleteForCustomTransform(id: String, force: Boolean = false): Unit
Marks a specific custom transform as deleted.
Marks a specific custom transform as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the custom transform.
- force
Whether to force deletion even if it leaves one or more pipelines invalid.
- abstract def postDeleteForFile(id: String, tag: String): Unit
Marks a specific file with a specific tag as deleted.
Marks a specific file with a specific tag as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the file.
- tag
The tag to require.
- abstract def postDeleteForPipeline(id: String, tag: String, force: Boolean = false): Unit
Marks a specific pipeline with a specific tag as deleted.
Marks a specific pipeline with a specific tag as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the pipeline.
- tag
The tag to require.
- force
Whether to force deletion even if it leaves one or more pipelines invalid.
- abstract def postDeleteForRegistry(id: String): Unit
Marks a specific registry as deleted.
Marks a specific registry as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the registry.
- abstract def postDeleteForRegistryEntity(registryId: String, id: String): Unit
Marks a specific registry entity as deleted.
Marks a specific registry entity as deleted. Technically a copy of the most recent version is created with the deletion time set.
- registryId
The unique id of the registry.
- id
The unique id of the registry entity.
- abstract def postDeleteForSource(id: String, tag: String, force: Boolean = false): Unit
Marks a specific source with a specific tag as deleted.
Marks a specific source with a specific tag as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the source.
- tag
The tag to require.
- force
Whether to force deletion even if it leaves one or more pipelines invalid.
- abstract def postDeleteVersionForConnection(id: String, version: UUID): Unit
Permanently deletes a specific version of a connection.
Permanently deletes a specific version of a connection.
- id
The unique id of the connection.
- version
The
UUIDfor the version.
- abstract def postFile(file: FileContent): Unit
Creates a new version of a file with the specific content.
Creates a new version of a file with the specific content.
- file
The content of the new version.
- abstract def postPlugins(plugins: PluginsContent): Unit
Creates new versions of a collection of custom functions, transforms and modules.
Creates new versions of a collection of custom functions, transforms and modules. The changes are validated in their entirety, and are only executed if validation succeeds.
- plugins
The PluginsContent
- abstract def postRegistry(content: RegistryContent): Unit
Creates a new version of a registry with the specific content.
Creates a new version of a registry with the specific content.
- content
The content of the new version.
- abstract def postRegistryEntity(content: RegistryEntityContent): Unit
Creates a new version of a registry entity with the specific content.
Creates a new version of a registry entity with the specific content.
- content
The content of the new version.
- abstract def postResourceForFile(id: String, tag: String, resource: Array[Byte], append: Boolean = false): Unit
Updates the data content of a specific file with a specific tag.
Updates the data content of a specific file with a specific tag. This requires the storage type of the file to be FileStorageTypes.file.
- id
The unique id of the file.
- tag
The tag to require.
- resource
The raw data content to store.
- append
Whether to append to the current file or overwrite.
- abstract def postRestart: Unit
- Definition Classes
- ServiceFacadeBase
- abstract def postTestEntityDataForRegistry(content: RegistryContent, data: String): Unit
Tests whether the data of a registry entity is compatible with a given registry definition.
Tests whether the data of a registry entity is compatible with a given registry definition.
- content
The definition of the registry.
- data
The RegistryEntityContent.entityData value to test.
- abstract def postVacuumDatabase: Unit
- Definition Classes
- ServiceFacadeWithDatabase
- abstract def setLogLevel(level: String): Unit
- Definition Classes
- ServiceFacadeBase
- abstract def withTimeout(seconds: Int): ConfigFacade
- Definition Classes
- ServiceFacade
- abstract def withToken(token: UUID): ConfigFacade
- Definition Classes
- ServiceFacade
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(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def getConfiguration: ConfigurationInfo
Gets the most recent version of each connection, source and pipeline.
- def getCustomApps: Array[CustomAppInfo]
Gets the most recent version of each custom app.
- def getCustomFunctions: Array[CustomFunctionInfo]
Gets the most recent version of each custom function.
- def getCustomModules: Array[CustomModuleInfo]
Gets the most recent version of each custom module.
- def getCustomTransforms: Array[CustomTransformInfo]
Gets the most recent version of each custom transform.
- def getRegistries: Array[RegistryInfo]
Gets the most recent version of each registry.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @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
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val postConfigurationDefaultValidateOnly: String
The default value for
validateOnlyused in postConfiguration.The default value for
validateOnlyused in postConfiguration. The value isfalse. - def postConnection(connection: ConnectionContent): Unit
Creates a new version of a connection with the specific content.
Creates a new version of a connection with the specific content.
- connection
The content of the new version.
- def postCustomFunction(customFunction: CustomFunctionContent): Unit
Creates a new version of a custom function with the specific content.
Creates a new version of a custom function with the specific content.
- customFunction
The content of the new version.
- def postCustomModule(customModule: CustomModuleContent): Unit
Creates a new version of a custom module with the specific content.
Creates a new version of a custom module with the specific content.
- customModule
The content of the new version.
- def postCustomTransform(customTransform: CustomTransformContent): Unit
Creates a new version of a custom transform with the specific content.
Creates a new version of a custom transform with the specific content.
- customTransform
The content of the new version.
- def postPipeline(pipeline: PipelineContent): Unit
Creates a new version of a pipeline with the specific content.
Creates a new version of a pipeline with the specific content.
- pipeline
The content of the new version.
- def postSource(source: SourceContent): Unit
Creates a new version of a source with the specific content.
Creates a new version of a source with the specific content.
- source
The content of the new version.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def waitIsReady(timeoutSeconds: Int, pollIntervalSeconds: Int): Unit
- Definition Classes
- ServiceFacadeBase
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)