リリースのキャンセル
<sf:cancelDeploy> タスクで進行中またはキュー内にあるリリースをキャンセルできます。
<sf:cancelDeploy> タスクは次のパラメータをサポートしています。
| 項目 | 説明 |
|---|---|
| username | sessionId が指定されていない場合は必須です。ログイン用の Salesforce ユーザ名。この接続に関連付けられるユーザ名には、「メタデータ API 関数を使用したメタデータを変更」権限が必要です。 |
| password | sessionId が指定されていない場合は必須です。このプロジェクトに関連付けられた組織にログインするために使用するパスワード。セキュリティトークンを使用している場合は、パスワードの最後に 25 桁のトークン値を貼り付けます。 |
| sessionId | username および password が指定されていない場合は必須です。有効な Salesforce セッションの ID または OAuth アクセストークン。セッションは、ユーザがユーザ名とパスワードを使用して正常に Salesforce にログインした後に作成されます。新しいセッションを作成するのではなく既存のセッションにログインする場合は、セッション ID を使用します。または、OAuth 認証のためのアクセストークンを使用します。詳細は、Salesforce ヘルプの「OAuth によるアプリケーションの認証」を参照してください。 |
| requestId | 必須。キャンセルする進行中またはキュー内にあるリリースの ID を指定します。 |
| serverurl | 省略可能。Salesforce サーバの URL (空白の場合、デフォルトは login.salesforce.com)。Sandbox インスタンスに接続するには、この URL を test.salesforce.com に変更します。 |
| maxPoll | 省略可能。デフォルトは 200 です。リリース要求の結果を得るためにサーバをポーリングする回数です。待機を停止した場合でも、リリースに成功することがあります。 |
| pollWaitMillis | 省略可能。デフォルトは 10000 です。リリース結果をポーリングする場合の待機時間 (ミリ秒単位) です。待機を停止した場合でも、リリースに成功することがあります。 |
| trace | 省略可能。デフォルトは false です。SOAP 要求と応答をコンソールに表示します。このオプションを選ぶと、ログイン時のユーザのパスワードがプレーンテキストで表示されます。 |
次の例に、リリースをキャンセルするターゲットを示します。requestId (sf.deployRequestId) の値は、build.properties ファイルで定義されます。
1<target name="cancel">
2 <sf:cancelDeploy username="${sf.username}" password="${sf.password}"
3 sessionId="${sf.sessionId}" serverurl="${sf.serverurl}" maxPoll="${sf.maxPoll}
4 requestId="${sf.deployRequestId}"/>
5</target>sf:cancelDeploy は、Ant 移行ツールのバージョン 34.0 以降でサポートされます。