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(オブジェクト payload)

POST /devops/tool/{capability} エンドポイントのペイロードから orchestrationTaskName パラメーターの値を返します。

REST エンドポイント DevOps - POST /devops/tool/{capability} を呼び出す前に、このメソッドをスクリプトインクルードに実装する必要があります。

表 : 1. パラメーター

名前	タイプ	説明
payload	オブジェクト	REST エンドポイント POST /devops/tool/{capability} によって受け入れられるカスタムツールからのデータを含むペイロードです。ここで capability は orchestration です。

表 : 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' 

};