プロファイルを実行
このシナリオでは、Talend APIを使ってプロファイルを実行し、プロジェクトクオリティを向上させます。
このタスクについて
APIコールの詳細は次のとおりです:
Method: POST
endpoint: api/v1/projects/quality/profiles/{id}/executions
payload:
{
"repository": "string",
"authentication": {
"username": "string",
"passcode": "string"
},
"branch": "string",
"workspace": "string",
"client": "UI"
}
このエンドポイントは、Talendプロジェクトで実行する仕様のリストが含まれているパラメーターとしてプロファイルIDを使用します。
手順
タスクの結果
{
"id": "67",
"status": "FAILED",
"startTimestamp": "2023-10-13 17:36",
"duration": "2s",
"specifications": [
{
"id": "69",
"specification": {
"id": "2",
"name": "best-practice",
"description": "This specification contains rules related to best practices",
"operator": "is_Equal_to",
"threshold": 100,
"thresholdType": "PERCENTAGE",
"createdBy": "system"
},
"status": "FAILED",
"rules": [
{
"id": "77",
"rule": {
"id": "4",
"name": "Active-tLogRow",
"description": "Identify jobs with tLogRow components",
"category": "COMPONENT",
"severity": "MINOR",
"operator": "is_less_than_or_Equal",
"threshold": "5",
"thresholdType": "PERCENTAGE",
"createdBy": "system"
},
"result": "30",
"status": "FAILED"
},
{
"id": "78",
"rule": {
"id": "5",
"name": "JavaLogs",
"description": "Identify jobs that contain java logs.",
"category": "COMPONENT",
"severity": "INFO",
"operator": "is_less_than_or_Equal",
"threshold": "50",
"thresholdType": "PERCENTAGE",
"createdBy": "system"
},
"result": "4.56",
"status": "PASSED"
}
],
"duration": "1s"
}
],
"sourceProvider": {
"providerType": "LOCAL",
"workspace": "D:\\Talend_Studio\\studio\\workspaces\\tcmp_test",
"project": "PROJECT_73"
},
"info": {
"version": "7.3.1",
"label": "PROJECT_73",
"description": "Project imported from TalendPS organization",
"productVersion": "Talend Real-time Big Data Platform-7.3.1.20221115_1012-patch",
"type": "DQ",
"bigData": false,
"local": false
},
"inventory": {
"total_artifact_assets": 258,
"context_group": 11,
"standard_job": 210,
"standard_job_versions": 211,
"standard_joblet": 24,
"standard_joblet_versions": 24,
"resource": 2,
"resource_versions": 24,
"bd_batch": 1,
"bd_batch_versions": 1,
"bd_batch_joblet": 0,
"bd_batch_joblet_versions": 0,
"bd_streaming": 1,
"bd_streaming_versions": 1,
"bd_streaming_joblet": 0,
"bd_streaming_joblet_versions": 0,
"route": 46,
"route_versions": 46,
"routelet": 1,
"routelet_versions": 1
},
"commits": [
{
"id": "24b228d45561e0a741a0409195ef492437bf3",
"date": "Tue Feb 21 01:29:11 2023 +0000",
"author": "talend <talend@3bed803c5b79>",
"message": "\tCreate Project: PRJ_731\n"
}
]
}
この例での結果は30となります。ルールのクオリティチェックが失敗します。ルールのステータスは[Failed] (失敗)となります。各ルールのステータスは、結果としきい値の比較に基づいて評価されます。
プロジェクトの全体的なクオリティは、仕様のステータスによって決定します。仕様のステータスは、すべてのルールの累積結果またはステータスによって検証されます。この例では、しきい値が100%に設定されています。ここでは、単一の条件やルールが失敗した場合でも、仕様は失敗し、ステータスは[Failed] (失敗)に設定されます。
しきい値、しきい値タイプ、演算子は、ルールと仕様がTalendプロジェクトのクオリティに与える影響に基づいてアップデートされます。
仕様がすべて実行されると、次の条件に基づいて実行ステータスが設定されます:
- [Passed] (合格): すべての仕様が合格した場合のステータス。
- [Failed] (失敗): いずれかの仕様が失敗した場合のステータス。
- [Canceled] (キャンセル済み): 実行がキャンセルされた場合のステータス。
- [Running] (実行中): 実行中のステータス。
実行ファイルには、GET /api/v1/projects/quality/profiles/executionsエンドポイントを使ってアクセスできます。 実行は、いくつかの基準(特定の開始時間からの実行ステータスやプロジェクト名など)でフィルタリングできます。
また、実行ID、ステータス、開始時間、プロジェクト名で実行を削除することもできます。