Class Source

Hierarchy

Base
- Source

Index

Constructors

Properties

Methods

getAllSources getSource searchSourceByName searchSources updateSource clone createNewSource createSourceInstances deleteSource

Constructors

constructor

new Source(workspace: WorkspaceModel): Source
Parameters
- workspace: WorkspaceModel
Returns Source

Overrides Base.constructor

Properties

forWorkspace

forWorkspace: WorkspaceModel

Methods

getAllSources

getAllSources(): Promise<SourceModel[]>
Returns Promise<SourceModel[]>

getSource

getSource(sourceId: string): Promise<SourceModel>
Parameters
- sourceId: string
Returns Promise<SourceModel>

searchSourceByName

searchSourceByName(name: string): Promise<SourceModel[]>
Parameters
- name: string
Returns Promise<SourceModel[]>

searchSources

searchSources(searchParams: SourceSearch): Promise<SourceModel[]>
Parameters
- searchParams: SourceSearch
Returns Promise<SourceModel[]>

updateSource

updateSource(sourceId: string, updateObject: Partial<SourceRead>): Promise<SourceModel>
Parameters
- sourceId: string
- updateObject: Partial<SourceRead>
Returns Promise<SourceModel>

`Static` clone

clone(sourceId: string, updateConfig: SourceCloneConfiguration, checkIfConfigIsValid?: boolean): Promise<SourceModel>
Parameters
- sourceId: string
- updateConfig: SourceCloneConfiguration
- checkIfConfigIsValid: boolean = true
Returns Promise<SourceModel>

`Static` createNewSource

createNewSource(createSourceData: SourceCreate, checkIfConfigIsValid?: boolean): Promise<SourceModel>
Parameters
- createSourceData: SourceCreate
- checkIfConfigIsValid: boolean = true
Returns Promise<SourceModel>

`Static` createSourceInstances

createSourceInstances(sources: SourceRead[]): SourceModel[]
Parameters
- sources: SourceRead[]
Returns SourceModel[]

`Static` deleteSource

deleteSource(sourceId: string): Promise<void>
Parameters
- sourceId: string
Returns Promise<void>

Generated using TypeDoc