DevOpsOrchestrationToolIntegrationHandler - 범위 지정됨

DevOpsOrchestrationToolIntegrationHandler API를 사용하면 사용자 지정 DevOps 도구에서 페이로드를 처리할 수 있습니다.

사용자 지정 DevOps 도구는 와 DevOps통합되지 않은 도구입니다. 통합이 있는 DevOps 도구 목록은 을 참조하십시오 DevOps Change Velocity integrations.

이 API를 사용하면 REST 엔드포인트 DevOps - POST /devops/tool/{capability}에서 사용하는 페이로드를 처리할 수 있습니다. POST /devops/tool/{capability} 엔드포인트를 호출하기 전에 스크립트 포함에서 이 API의 메서드를 구현해야 합니다.

이 API는 sn_devops 네임스페이스에서 실행됩니다. DevOps에 대한 자세한 내용은 DevOps Config 문서를 참조하십시오.

DevOpsOrchestrationToolIntegrationHandler - getNativeIdForOrchestrationTask(객체 페이로드)

POST /devops/tool/{capability} 엔드포인트에 대한 페이로드에서 매개변수 값을 orchestrationTaskName 반환합니다.

REST 엔드포인트 DevOps - POST /devops/tool/{capability}를 호출하기 전에 스크립트 포함에서 이 메서드를 구현해야 합니다.

표 1. 매개변수

이름	유형	설명
페이로드	객체	REST 엔드포인트 POST /devops/tool/{capability}에서 수락한 사용자 지정 도구의 데이터를 포함하는 페이로드이며, 여기서 capability는 오케스트레이션입니다.

표 2. 반환

유형	설명
문자열	페이로드의 orchestrationTaskName 매개변수 값입니다.

이 예시에서 DevOpsOrchestrationCustomToolIntegrationHandler 라는 스크립트 포함은 handleTool 및 getNativeIdForOrchestrationTask 메서드를 구현합니다. getNativeIdForOrchestrationTask 메서드는 POST /devops/tool/{capability}에 대한 페이로드에서 매개변수 값을 orchestrationTaskName 반환하도록 구현됩니다.

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(문자열, toolName)

이 핸들러가 지정된 도구에 유효한지 확인합니다.

DevOps - POST /devops/tool/{capability}를 호출하기 전에 스크립트 포함에서 이 메서드를 구현해야 합니다.

표 3. 매개변수

이름	유형	설명
toolName	문자열	도구의 이름입니다. DevOps 도구 통합 [sn_devops_tool_integration] 테이블의 도구 이름 필드에 있습니다.

표 4. 반환

유형	설명
부울	이 처리기가 지정된 도구에 유효한지 여부를 나타내는 플래그입니다. 가능한 값: true: 지정된 도구에 이 핸들러를 사용할 수 있습니다. false: 지정된 도구에 이 처리기를 사용할 수 없습니다.

이 예시에서 DevOpsOrchestrationCustomToolIntegrationHandler 라는 스크립트 포함은 handleTool 및 getNativeIdForOrchestrationTask 메서드를 구현합니다. handleTool 메서드는 전달된 이름이 올바른 도구에 대한 것인지 확인하기 위해 구현됩니다. 'sn_devops_custom_tool'를 사용 중인 도구의 이름으로 바꿉니다.

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' 

};