Erstellen einer Komponentenregel

In diesem Szenario verwenden Sie Talend-APIs zum Erstellen einer Komponentenregel, um die Projektqualität zu verbessern.

Warum und wann dieser Vorgang ausgeführt wird

Im Folgenden finden Sie einige Informationen zum API-Aufruf:

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. Rufen Sie den Endpunkt POST /api/v1/projects/quality/rules/category/component auf, um eine Regel der Kategorie Component (Komponente) zu erstellen. Für das Erstellen von Regeln einer anderen Komponenten sind weitere Endpunkte verfügbar.
2. Geben Sie im Bereich Body folgende Informationen ein:

   Parametername	Wert
   name	Geben Sie den Namen der Regel ein.
   description	Geben Sie die Beschreibung der Regel ein.
   severity	Geben Sie den Schweregrad der Regel ein. Der Schweregrad hängt von der Auswirkung der Regel auf die Projektqualität ab. Sie können einen der folgenden Schweregradtypen angeben: Info, Minor (Leicht), Major (Schwer), Critical (Kritisch).
   operator	Wählen Sie einen Vergleichsoperator für den Vergleich mit dem Schwellenwert aus: <=, \>=, =, \>=
   value	Geben Sie einen Wert für den Schwellenwert ein. Dies ist ein Wert, der eine Grenze festlegt. Ober- oder unterhalb dieser Grenze muss eine Bedingung erfüllt sein. Dieses Feld akzeptiert numerische Werte ab 0.
   type	Geben Sie einen der folgenden Schwellenwerttypen ein: Percentage (Prozentsatz) oder Numeric (Numerisch).
   components	Geben Sie die Konnektoren- oder Komponentennamen ein.
   parameters	Jede Komponente bzw. jeder Knoten in einem Job kann Parameter wie CODE, URL oder URI enthalten. Beispielsweise hat die Komponente „tJava“ einen Parameter CODE. Jeder Job kann Parameter (PROJECT_PARAMETER) wie IMPLICIT_LOAD oder MULTI_THREAD_EXECUTION enthalten. Jede Verbindung kann Parameter wie PARTITIONER oder NUM_PARTITIONS enthalten.
   inputs	Sie können eine Liste regulärer Ausdrücke oder beliebigen Text zum Validieren der Regel hinzufügen.
   exists	Bestimmt, ob eine bestimmte Komponente im Job vorhanden ist. Die Werte können true (wahr) oder false (falsch) sein.

   Beispiel:

    {
       "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. Klicken Sie auf Execute (Ausführen), um den Aufruf auszugeben.