コンポーネントルールを作成

このシナリオでは、Talend APIを使ってコンポーネントルールを作成し、プロジェクトクオリティを向上させます。

このタスクについて

APIコールの詳細は次のとおりです:

Method: POST
endpoint: api/v1/projects/quality/rules/category/components
payload:
    {
    "name": "string",
    "description": "string",
    "severity": "Info",
    "category": "Component",
    "threshold": {
      "operator": "string",
      "value": 0,
      "type": "Percentage"
    },
    "components": [
      "string"
    ],
    "parameters": [
      "string"
    ],
    "inputs": [
      "string"
    ],
    "exists": true
  }

1. POST /api/v1/projects/quality/rules/category/componentエンドポイントを呼び出し、[Component] (コンポーネント)カテゴリーのルールを作成します。他のカテゴリーのルールを作成したい場合は、他のエンドポイントも利用できます。
2. [Body] (ボディ)エリアに、次の情報を入力します:

   パラメーター名	値
   name	ルールの名前を入力します。
   description	ルールの説明を入力します。
   severity	ルールの重大度を入力します。重大度は、そのルールがプロジェクトクオリティに与える影響に基づいて設定されます。重大度タイプとして、Info、Minor、Major、Criticalのいずれかを指定できます。
   operator	しきい値と比較する演算子として次のいずれかを指定します: <=、\>=、=、\>=
   value	しきい値の値を入力します。この値によって、ある条件が観察されるべき上限または境界が設定されます。このフィールドには0から始まる数値を入力できます。
   type	しきい値タイプ(PercentageまたはNumeric)を入力します。
   components	コネクターまたはコンポーネントの名前を入力します。
   parameters	ジョブ内の各コンポーネントやノードはパラメーター(CODE、URL、URIなど)を持つことができます。たとえば、tJavaコンポーネントにはCODEパラメーターがあります。 ジョブはそれぞれ、IMPLICIT_LOADやMULTI_THREAD_EXECUTIONといったパラメーター(PROJECT_PARAMETER)を持つことがあります。 接続はそれぞれ、PARTITIONERやNUM_PARTITIONSといったパラメーターを持つことがあります。
   inputs	正規表現のリストか、ルールを検証するためのテキストを追加できます。
   exists	特定のコンポーネントがジョブ内に存在するかどうかを判断します。値としてtrueかfalseを指定します。

   例:

    {
       "name": "Java Logs",
       "description": "Identify Jobs that contain java logs",
       "severity": "Info",
       "category": "Component",
       "threshold": {
         "operator": "<=",
         "value": 0,
         "type": "Numeric"
       },
       "components": [
         "tJava", "tJavaFlex", "tJavaRow"
       ],
       "parameters": [
         "CODE", "CODE_START", "CODE_MAIN", "CODE_END"
       ],
       "inputs": [
         "System.out.print", "System.err.print"
       ],
       "exists": true
     }

3. [Execute] (実行)をクリックしてコールを発行します。