付録D.2 APIで取得できるユニット定義情報オブジェクトのメンバーの一覧
APIで取得できるユニット定義情報オブジェクトのメンバーの一覧を次の表に示します。
項番 |
メンバー |
取得情報 |
ユニット一覧の取得API |
ユニット情報の取得API |
情報を取得できない場合のデフォルト値 |
---|---|---|---|---|---|
1 |
unitName |
ユニット完全名 |
○ |
○ |
""(空文字) |
2 |
simpleUnitName |
ユニット名 |
○ |
○ |
""(空文字) |
3 |
unitComment |
ユニットのコメント |
○ |
○ |
""(空文字) |
4 |
unitType |
ユニット種別 |
○ |
○ |
"NONE" |
5 |
customJobType |
カスタムジョブの種別 |
○ |
○ |
""(空文字) |
6 |
owner |
所有者 |
○ |
○ |
""(空文字) |
7 |
jp1ResourceGroup |
JP1資源グループ名 |
○ |
○ |
""(空文字) |
8 |
execAgent |
実行エージェント名 |
○ |
○ |
""(空文字) |
9 |
execFileName |
実行ファイル名またはスクリプトファイル名 |
○ |
○ |
""(空文字) |
10 |
parameters |
パラメーター |
○ |
○ |
""(空文字) |
11 |
registerStatus |
ユニットの登録状態 |
○※ |
○ |
"NONE" |
12 |
unitID |
ユニットID |
○ |
○ |
-1 |
13 |
recoveryUnit |
リカバリーユニットかどうか |
○ |
○ |
false |
14 |
jobnetReleaseUnit |
リリース登録されているかどうか |
○ |
○ |
false |
15 |
wait |
待ち合わせ条件付きユニットかどうか |
○ |
○ |
false |
16 |
rootJobnetName |
ルートジョブネットのユニット完全名 |
○ |
○ |
""(空文字) |
17 |
customEventJobType |
カスタムイベントジョブの種別 |
○ |
○ |
""(空文字) |
- (凡例)
-
○:取得できます。
×:取得できません。デフォルト値を返却します。
- 注※
-
取得対象の範囲に「定義だけ」を指定した場合は,情報を取得しません。デフォルト値を返却します。