DevOpsOrchestrationToolIntegrationHandler : inclus dans le champ d’application

L’API DevOpsOrchestrationToolIntegrationHandler permet le traitement des charges utiles à partir d’outils personnalisés DevOps .

Un outil personnalisé DevOps est un outil qui n’a pas d’intégration avec DevOps. Pour obtenir la liste des outils dotés d’intégrations DevOps , reportez-vous à la section DevOps Change Velocity integrations.

Cette API permet le traitement des charges utiles utilisées par le point de terminaison REST DevOps : POST /devops/tool/{capability}. Vous devez implémenter les méthodes de cette API dans un include de script avant d’appeler le point de terminaison POST /devops/tool/{capability} .

Cette API s’exécute dans l’espace de noms sn_devops . Pour plus d'informations sur DevOps, consultez DevOps Config.

DevOpsOrchestrationToolIntegrationHandler : getNativeIdForOrchestrationTask(charge utile de l’objet)

Renvoie la valeur du paramètre à partir de la orchestrationTaskName charge utile pour le point de terminaison POST /devops/tool/{capability} .

Vous devez implémenter cette méthode dans un include de script avant d’appeler le point de terminaison REST DevOps - POST /devops/tool/{capability}.

Tableau 1. Paramètres

Nom	Type	Description
payload	Objet	Charge utile contenant les données de l’outil personnalisé acceptée par le point de terminaison REST POST /devops/tool/{capability}, où capability se trouve l’orchestration.

Tableau 2. Renvoie

Type	Description
Chaîne	Valeur du orchestrationTaskName paramètre de la charge utile.

Dans cet exemple, un include de script nommé DevOpsOrchestrationCustomToolIntegrationHandler implémente les méthodes handleTool et getNativeIdForOrchestrationTask. La méthode getNativeIdForOrchestrationTask est implémentée pour renvoyer la valeur du paramètre à partir de orchestrationTaskName la charge utile pour POST /devops/tool/{capability}.

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(String toolName)

Vérifie si ce gestionnaire est valide pour l’outil spécifié.

Vous devez implémenter cette méthode dans un include de script avant d’appeler DevOps - POST /devops/tool/{capability}.

Tableau 3. Paramètres

Nom	Type	Description
toolName	Chaîne	Nom de l’outil. Situé dans le champ Nom de l’outil de la table Intégration de l’outil DevOps [sn_devops_tool_integration].

Tableau 4. Renvoie

Type	Description
Booléen	Marqueur indiquant si ce gestionnaire est valide pour l’outil spécifié. Valeurs possibles : true : ce gestionnaire peut être utilisé pour l’outil spécifié. false : ce gestionnaire ne peut pas être utilisé pour l’outil spécifié.

Dans cet exemple, un include de script nommé DevOpsOrchestrationCustomToolIntegrationHandler implémente les méthodes handleTool et getNativeIdForOrchestrationTask. La méthode handleTool est implémentée pour vérifier que le nom transmis est destiné à l’outil correct. Remplacez « sn_devops_custom_tool » par le nom de l’outil que vous utilisez.

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' 

};