ConnectorIssueReporter Interface
Abstract implementation of the Issue Reporter
Implemented by
Properties
Name | Type | Description | |
---|---|---|---|
close | () => Promise<void> | Close the issue reporter and any database connections | |
getReportPath | () => string | Returns the path to the report file | |
publishReport | () => Promise<void> | Creates a JSON report file to be uploaded by the orchestrator | |
recordIgnoredElements | (repositoryLinkId: string, ignoredElementIdList: string) => void | Records element that have not been visited during the running of the connector | |
recordReferenceFileInfo | (sourceId: string, name: string, uniqueName: string, itemType: string, dataSource: string, downloadUrl: string, state: string, failureReason: string, exists: boolean, fileSize: number, foundByConnector: boolean) => void | Records additional files for a connector job | |
recordSourceFileInfo | (sourceId: string, name: string, uniqueName: string, itemType: string, dataSource: string, state: string, failureReason: string, exists: boolean, fileSize: number, foundByConnector: boolean, downloadUrl?: string) => void | Records file information for a connector job. | |
reportIssue | (ecInstanceId: string, sourceId: string, level: "Error" | "Warning", category: string, message: string, type: string) => void | Reports a generic issue encountered by the connector. |
Defined in
- ConnectorIssueReporter.ts Line 9
Last Updated: 13 May, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.