DevOpsOrchestrationToolIntegrationHandler - Com escopo

A API DevOpsOrchestrationToolIntegrationHandler permite o processamento de cargas de ferramentas DevOps personalizadas.

Uma ferramenta DevOps personalizada é qualquer ferramenta que não tenha uma integração com DevOps. Para obter uma lista de ferramentas que têm integrações DevOps, consulte DevOps Change Velocity integrations.

Esta API permite o processamento de cargas úteis que são usadas pelo endpoint REST DevOps - POST /devops/tool/{capability}. Você deve implementar os métodos desta API em uma inclusão de script antes de chamar o endpoint POST /devops/tool/{capability}.

Esta API é executada no namespace sn_devops. Para obter mais informações sobre DevOps, consulte DevOps Config.

DevOpsOrchestrationToolIntegrationHandler - getNativeIdForOrchestrationTask (carga do objeto)

Retorna o valor do parâmetro orchestrationTaskName da carga para o endpoint POST /devops/tool/{capability}.

Você deve implementar este método em uma inclusão de script antes de chamar o endpoint REST DevOps - POST /devops/tool/{capability}.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
carga	Objeto	Carga que contém dados da ferramenta personalizada que são aceitos pelo endpoint REST POST /devops/tool/{capability}, em que capability é a orquestração.

Tabela 2. Retorna

Tipo	Descrição
Cadeia de caracteres	Valor do parâmetro orchestrationTaskName da carga útil.

Neste exemplo, uma inclusão de script chamada DevOpsOrchestrationCustomToolIntegrationHandler implementa os métodos handleTool e getNativeIdForOrchestrationTask. O método getNativeIdForOrchestrationTask é implementado para retornar o valor do parâmetro orchestrationTaskName da carga para 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)

Verifica se este manipulador é válido para a ferramenta especificada.

Você deve implementar este método em uma inclusão de script antes de chamar DevOps - POST /devops/tool/{capability}.

Tabela 3. Parâmetros

Nome	Tipo	Descrição
toolName	Cadeia de caracteres	Nome da ferramenta. Localizado no campo Nome da ferramenta na tabela Integração da ferramenta de DevOps [sn_devops_tool_integration].

Tabela 4. Retorna

Tipo	Descrição
Booliano	Sinalizador que indica se este manipulador é válido para a ferramenta especificada. Valores possíveis: verdadeiro: este manipulador pode ser usado para a ferramenta especificada. falso: este manipulador não pode ser usado para a ferramenta especificada.

Neste exemplo, uma inclusão de script chamada DevOpsOrchestrationCustomToolIntegrationHandler implementa os métodos handleTool e getNativeIdForOrchestrationTask. O método handleTool é implementado para verificar se o nome passado é para a ferramenta correta. Substitua "sn_devops_custom_tool" pelo nome da ferramenta que você está usando.

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' 

};