@sourceloop/reporting-service / Exports / IngestionMappingsService
Class: IngestionMappingsService¶
Table of contents¶
Constructors¶
Properties¶
Methods¶
Constructors¶
constructor¶
• new IngestionMappingsService(ingestionMappingsRepository)
Parameters¶
| Name | Type |
|---|---|
ingestionMappingsRepository |
IngestionMappingsRepository |
Defined in¶
services/reporting-service/src/services/ingestion-mappings.service.ts:7
Properties¶
ingestionMappingsRepository¶
• Private Readonly ingestionMappingsRepository: IngestionMappingsRepository
Defined in¶
services/reporting-service/src/services/ingestion-mappings.service.ts:9
Methods¶
create¶
▸ create(ingestionMapObj): IngestionMapping | Promise<IngestionMapping>
The function creates an ingestion mapping object and returns it or a promise of it.
Parameters¶
| Name | Type |
|---|---|
ingestionMapObj |
IngestionMapping |
Returns¶
IngestionMapping | Promise<IngestionMapping>
either an IngestionMappings object or a Promise that resolves to an IngestionMappings object.
Defined in¶
services/reporting-service/src/services/ingestion-mappings.service.ts:65
deleteByName¶
▸ deleteByName(dataSourceName): void | PromiseLike<void>
The function deleteByName deletes a record from the ingestionMappingsRepository based on the
provided dataSourceName.
Parameters¶
| Name | Type | Description |
|---|---|---|
dataSourceName |
string |
The parameter dataSourceName is a string that represents the name of the data source to be deleted. |
Returns¶
void | PromiseLike<void>
either void or a Promise that resolves to void.
Defined in¶
services/reporting-service/src/services/ingestion-mappings.service.ts:18
getAll¶
▸ getAll(): Promise<IngestionMapping[]>
The function getAll returns a promise that resolves to an array of IngestionMappings objects.
Returns¶
Promise<IngestionMapping[]>
The getAll() function is returning a Promise that resolves to an array of IngestionMappings objects.
Defined in¶
services/reporting-service/src/services/ingestion-mappings.service.ts:37
getByName¶
▸ getByName(dataSourceName): IngestionMapping | Promise<IngestionMapping>
The function "getByName" retrieves ingestion mappings by their data source name.
Parameters¶
| Name | Type | Description |
|---|---|---|
dataSourceName |
string |
A string representing the name of the data source. |
Returns¶
IngestionMapping | Promise<IngestionMapping>
either an IngestionMappings object or a Promise that resolves to an IngestionMappings object.
Defined in¶
services/reporting-service/src/services/ingestion-mappings.service.ts:27
getCount¶
▸ getCount(): Promise<Count>
The getCount function returns a promise that resolves to the count of ingestion mappings.
Returns¶
Promise<Count>
The getCount() function is returning a Promise that resolves to a Count object.
Defined in¶
services/reporting-service/src/services/ingestion-mappings.service.ts:74
update¶
▸ update(dataSourceName, ingestionMapObj): Promise<void>
The function updates an ingestion mapping object in a data source repository.
Parameters¶
| Name | Type | Description |
|---|---|---|
dataSourceName |
string |
A string representing the name of the data source. |
ingestionMapObj |
IngestionMapping |
- |
Returns¶
Promise<void>
a Promise that resolves to void.
Defined in¶
services/reporting-service/src/services/ingestion-mappings.service.ts:48