DevOpsOrchestrationToolIntegrationHandler : Bereichsbezogen

Die DevOpsOrchestrationToolIntegrationHandler -API ermöglicht die Verarbeitung von Nutzlasten aus anwenderdefinierten DevOps -Tools.

Ein anwenderdefiniertes DevOps -Tool ist jedes Tool, das keine Integration mit DevOpshat. Eine Liste der Tools mit DevOps -Integrationen finden Sie unter DevOps Change Velocity integrations.

Diese API ermöglicht die Verarbeitung von Nutzlasten, die vom REST-Endpunkt DevOps – POST /devops/tool/{capability}verwendet werden. Sie müssen die Methoden dieser API in einer Skripteinbindung implementieren, bevor Sie den Endpunkt POST /devops/tool/{capability} aufrufen.

Diese API wird im Namespace sn_devops ausgeführt. Weitere Informationen zu DevOps finden Sie unter DevOps Config.

DevOpsOrchestrationToolIntegrationHandler – getNativeIdForOrchestrationTask(Object payload)

Gibt den Wert des Parameters orchestrationTaskName aus der Nutzlast für den Endpunkt POST /devops/tool/{capability} zurück.

Sie müssen diese Methode in einer Skripteinbindung implementieren, bevor Sie den REST-Endpunkt DevOps - POST /devops/tool/{capability}aufrufen.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Nutzlast	Objekt	Nutzlast, die Daten aus dem anwenderdefinierten Tool enthält, die vom REST-Endpunkt POST /devops/tool/{capability}akzeptiert wird, wobei capability für die Orchestrationsteht.

Tabelle : 2. Rückgaben

Typ	Beschreibung
Zeichenfolge	Wert des Parameters orchestrationTaskName aus der Nutzlast.

In diesem Beispiel implementiert eine Skripteinbindung namens DevOpsOrchestrationCustomToolIntegrationHandler die Methoden handleTool und getNativeIdForOrchestrationTask. Die Methode „getNativeIdForOrchestrationTask“ ist implementiert, um den Wert des Parameters orchestrationTaskName aus der Nutzlast für POST /devops/tool/{capability} zurückzugeben.

var DevOpsOrchestrationCustomToolIntegrationHandler = Class.create(); 

DevOpsOrchestrationCustomToolIntegrationHandler.prototype = {     

    handleTool: function(toolName) { 
        if (!gs.nil(toolName) && toolName == 'sn_devops_custom_tool') 
            return true; 
        return false; 
    }, 

    getNativeIdForOrchestrationTask: function(payload) { 
        return payload.orchestrationTaskName; 
    }, 

    type: 'DevOpsOrchestrationCustomToolIntegrationHandler' 

}; 

DevOpsOrchestrationToolIntegrationHandler – handleTool(StringtoolName)

Überprüft, ob dieser Handler für das angegebene Tool gültig ist.

Sie müssen diese Methode in einer Skripteinbindung implementieren, bevor Sie DevOps - POST /devops/tool/{capability}aufrufen.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
toolName	Zeichenfolge	Name des Tools. Tabelle: Feld „Toolname“ der Tabelle „DevOps-Toolintegration“ [sn_devops_tool_integration].

Tabelle : 4. Rückgaben

Typ	Beschreibung
Boolean	Kennzeichnung, die angibt, ob dieser Handler für das angegebene Tool gültig ist. Mögliche Werte: wahr: Dieser Handler kann für das angegebene Tool verwendet werden. „falsch“: Dieser Handler kann für das angegebene Tool nicht verwendet werden.

In diesem Beispiel implementiert eine Skripteinbindung namens DevOpsOrchestrationCustomToolIntegrationHandler die Methoden handleTool und getNativeIdForOrchestrationTask. Die Methode „handleTool“ wird implementiert, um zu überprüfen, ob der übergebene Name für das richtige Tool gilt. Ersetzen Sie „sn_devops_custom_tool“ durch den Namen des verwendeten Tools.

var DevOpsOrchestrationCustomToolIntegrationHandler = Class.create(); 

DevOpsOrchestrationCustomToolIntegrationHandler.prototype = {     

  handleTool: function(toolName) { 
    if (!gs.nil(toolName) && toolName == 'sn_devops_custom_tool') 
      return true; 
    return false; 
  }, 

  getNativeIdForOrchestrationTask: function(payload) { 
    return payload.orchestrationTaskName; 
  }, 

  type: 'DevOpsOrchestrationCustomToolIntegrationHandler' 

};