JobSchedule class
JobSchedule を表すクラス。
コンストラクター
| Job |
JobSchedule を作成します。 |
メソッド
コンストラクターの詳細
JobSchedule(BatchServiceClientContext)
JobSchedule を作成します。
new JobSchedule(client: BatchServiceClientContext)パラメーター
- client
- BatchServiceClientContext
サービス クライアントへの参照。
メソッドの詳細
add(JobScheduleAddParameter, JobScheduleAddOptionalParams)
function add(cloudJobSchedule: JobScheduleAddParameter, options?: JobScheduleAddOptionalParams): Promise<JobScheduleAddResponse>パラメーター
- cloudJobSchedule
- JobScheduleAddParameter
追加するジョブ スケジュール。
- options
- JobScheduleAddOptionalParams
省略可能なパラメーター
戻り値
Promise<JobScheduleAddResponse>
Promise<Models.JobScheduleAddResponse応答>
add(JobScheduleAddParameter, JobScheduleAddOptionalParams, ServiceCallback<void>)
function add(cloudJobSchedule: JobScheduleAddParameter, options: JobScheduleAddOptionalParams, callback: ServiceCallback<void>)パラメーター
- cloudJobSchedule
- JobScheduleAddParameter
追加するジョブ スケジュール。
- options
- JobScheduleAddOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
add(JobScheduleAddParameter, ServiceCallback<void>)
function add(cloudJobSchedule: JobScheduleAddParameter, callback: ServiceCallback<void>)パラメーター
- cloudJobSchedule
- JobScheduleAddParameter
追加するジョブ スケジュール。
- callback
-
ServiceCallback<void>
コールバック
deleteMethod(string, JobScheduleDeleteMethodOptionalParams)
ジョブ スケジュールを削除すると、そのスケジュールの下にあるすべてのジョブとタスクも削除されます。 タスクが削除されると、コンピューティング ノード上の作業ディレクトリ内のすべてのファイルも削除されます (保持期間は無視されます)。 ジョブ スケジュール統計は、ジョブ スケジュールが削除されるとアクセスできなくなりますが、アカウントの有効期間の統計にはカウントされます。
function deleteMethod(jobScheduleId: string, options?: JobScheduleDeleteMethodOptionalParams): Promise<JobScheduleDeleteResponse>パラメーター
- jobScheduleId
-
string
削除するジョブ スケジュールの ID。
省略可能なパラメーター
戻り値
Promise<JobScheduleDeleteResponse>
Promise<Models.JobScheduleDeleteResponse応答>
deleteMethod(string, JobScheduleDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(jobScheduleId: string, options: JobScheduleDeleteMethodOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobScheduleId
-
string
削除するジョブ スケジュールの ID。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(jobScheduleId: string, callback: ServiceCallback<void>)パラメーター
- jobScheduleId
-
string
削除するジョブ スケジュールの ID。
- callback
-
ServiceCallback<void>
コールバック
disable(string, JobScheduleDisableOptionalParams)
ジョブ スケジュールが再度有効になるまで、新しいジョブは作成されません。
function disable(jobScheduleId: string, options?: JobScheduleDisableOptionalParams): Promise<JobScheduleDisableResponse>パラメーター
- jobScheduleId
-
string
無効にするジョブ スケジュールの ID。
- options
- JobScheduleDisableOptionalParams
省略可能なパラメーター
戻り値
Promise<JobScheduleDisableResponse>
Promise<Models.JobScheduleDisableResponse応答>
disable(string, JobScheduleDisableOptionalParams, ServiceCallback<void>)
function disable(jobScheduleId: string, options: JobScheduleDisableOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobScheduleId
-
string
無効にするジョブ スケジュールの ID。
- options
- JobScheduleDisableOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
disable(string, ServiceCallback<void>)
function disable(jobScheduleId: string, callback: ServiceCallback<void>)パラメーター
- jobScheduleId
-
string
無効にするジョブ スケジュールの ID。
- callback
-
ServiceCallback<void>
コールバック
enable(string, JobScheduleEnableOptionalParams)
function enable(jobScheduleId: string, options?: JobScheduleEnableOptionalParams): Promise<JobScheduleEnableResponse>パラメーター
- jobScheduleId
-
string
有効にするジョブ スケジュールの ID。
- options
- JobScheduleEnableOptionalParams
省略可能なパラメーター
戻り値
Promise<JobScheduleEnableResponse>
Promise<Models.JobScheduleEnableResponseです>
enable(string, JobScheduleEnableOptionalParams, ServiceCallback<void>)
function enable(jobScheduleId: string, options: JobScheduleEnableOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobScheduleId
-
string
有効にするジョブ スケジュールの ID。
- options
- JobScheduleEnableOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
enable(string, ServiceCallback<void>)
function enable(jobScheduleId: string, callback: ServiceCallback<void>)パラメーター
- jobScheduleId
-
string
有効にするジョブ スケジュールの ID。
- callback
-
ServiceCallback<void>
コールバック
exists(string, JobScheduleExistsOptionalParams)
function exists(jobScheduleId: string, options?: JobScheduleExistsOptionalParams): Promise<JobScheduleExistsResponse>パラメーター
- jobScheduleId
-
string
確認するジョブ スケジュールの ID。
- options
- JobScheduleExistsOptionalParams
省略可能なパラメーター
戻り値
Promise<JobScheduleExistsResponse>
Promise<Models.JobScheduleExistsResponse応答>
exists(string, JobScheduleExistsOptionalParams, ServiceCallback<boolean>)
function exists(jobScheduleId: string, options: JobScheduleExistsOptionalParams, callback: ServiceCallback<boolean>)パラメーター
- jobScheduleId
-
string
確認するジョブ スケジュールの ID。
- options
- JobScheduleExistsOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<boolean>
コールバック
exists(string, ServiceCallback<boolean>)
function exists(jobScheduleId: string, callback: ServiceCallback<boolean>)パラメーター
- jobScheduleId
-
string
確認するジョブ スケジュールの ID。
- callback
-
ServiceCallback<boolean>
コールバック
get(string, JobScheduleGetOptionalParams)
指定したジョブ スケジュールに関する情報を取得します。
function get(jobScheduleId: string, options?: JobScheduleGetOptionalParams): Promise<JobScheduleGetResponse>パラメーター
- jobScheduleId
-
string
取得するジョブ スケジュールの ID。
- options
- JobScheduleGetOptionalParams
省略可能なパラメーター
戻り値
Promise<JobScheduleGetResponse>
Promise<Models.JobScheduleGetResponse>
get(string, JobScheduleGetOptionalParams, ServiceCallback<CloudJobSchedule>)
function get(jobScheduleId: string, options: JobScheduleGetOptionalParams, callback: ServiceCallback<CloudJobSchedule>)パラメーター
- jobScheduleId
-
string
取得するジョブ スケジュールの ID。
- options
- JobScheduleGetOptionalParams
省略可能なパラメーター
- callback
コールバック
get(string, ServiceCallback<CloudJobSchedule>)
function get(jobScheduleId: string, callback: ServiceCallback<CloudJobSchedule>)パラメーター
- jobScheduleId
-
string
取得するジョブ スケジュールの ID。
- callback
コールバック
list(JobScheduleListOptionalParams)
function list(options?: JobScheduleListOptionalParams): Promise<JobScheduleListResponse>パラメーター
- options
- JobScheduleListOptionalParams
省略可能なパラメーター
戻り値
Promise<JobScheduleListResponse>
Promise<Models.JobScheduleListResponse応答>
list(JobScheduleListOptionalParams, ServiceCallback<CloudJobScheduleListResult>)
function list(options: JobScheduleListOptionalParams, callback: ServiceCallback<CloudJobScheduleListResult>)パラメーター
- options
- JobScheduleListOptionalParams
省略可能なパラメーター
- callback
コールバック
list(ServiceCallback<CloudJobScheduleListResult>)
function list(callback: ServiceCallback<CloudJobScheduleListResult>)パラメーター
- callback
コールバック
listNext(string, JobScheduleListNextOptionalParams)
function listNext(nextPageLink: string, options?: JobScheduleListNextOptionalParams): Promise<JobScheduleListResponse>パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
省略可能なパラメーター
戻り値
Promise<JobScheduleListResponse>
Promise<Models.JobScheduleListResponse応答>
listNext(string, JobScheduleListNextOptionalParams, ServiceCallback<CloudJobScheduleListResult>)
function listNext(nextPageLink: string, options: JobScheduleListNextOptionalParams, callback: ServiceCallback<CloudJobScheduleListResult>)パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
省略可能なパラメーター
- callback
コールバック
listNext(string, ServiceCallback<CloudJobScheduleListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CloudJobScheduleListResult>)パラメーター
- nextPageLink
-
string
List 操作に対する前回の正常な呼び出しからの NextLink。
- callback
コールバック
patch(string, JobSchedulePatchParameter, JobSchedulePatchOptionalParams)
これにより、要求で指定されたジョブ スケジュール プロパティのみが置き換えられます。 たとえば、この要求で schedule プロパティが指定されていない場合、Batch サービスは既存のスケジュールを保持します。 ジョブ スケジュールに対する変更は、更新が行われた後にスケジュールによって作成されたジョブにのみ影響します。現在実行中のジョブは影響を受けません。
function patch(jobScheduleId: string, jobSchedulePatchParameter: JobSchedulePatchParameter, options?: JobSchedulePatchOptionalParams): Promise<JobSchedulePatchResponse>パラメーター
- jobScheduleId
-
string
更新するジョブ スケジュールの ID。
- jobSchedulePatchParameter
- JobSchedulePatchParameter
要求のパラメーター。
- options
- JobSchedulePatchOptionalParams
省略可能なパラメーター
戻り値
Promise<JobSchedulePatchResponse>
Promise<Models.JobSchedulePatchResponse応答>
patch(string, JobSchedulePatchParameter, JobSchedulePatchOptionalParams, ServiceCallback<void>)
function patch(jobScheduleId: string, jobSchedulePatchParameter: JobSchedulePatchParameter, options: JobSchedulePatchOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobScheduleId
-
string
更新するジョブ スケジュールの ID。
- jobSchedulePatchParameter
- JobSchedulePatchParameter
要求のパラメーター。
- options
- JobSchedulePatchOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
patch(string, JobSchedulePatchParameter, ServiceCallback<void>)
function patch(jobScheduleId: string, jobSchedulePatchParameter: JobSchedulePatchParameter, callback: ServiceCallback<void>)パラメーター
- jobScheduleId
-
string
更新するジョブ スケジュールの ID。
- jobSchedulePatchParameter
- JobSchedulePatchParameter
要求のパラメーター。
- callback
-
ServiceCallback<void>
コールバック
terminate(string, JobScheduleTerminateOptionalParams)
function terminate(jobScheduleId: string, options?: JobScheduleTerminateOptionalParams): Promise<JobScheduleTerminateResponse>パラメーター
- jobScheduleId
-
string
終了するジョブ スケジュールの ID。
省略可能なパラメーター
戻り値
Promise<JobScheduleTerminateResponse>
Promise<Models.JobScheduleTerminateResponse応答>
terminate(string, JobScheduleTerminateOptionalParams, ServiceCallback<void>)
function terminate(jobScheduleId: string, options: JobScheduleTerminateOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobScheduleId
-
string
終了するジョブ スケジュールの ID。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
terminate(string, ServiceCallback<void>)
function terminate(jobScheduleId: string, callback: ServiceCallback<void>)パラメーター
- jobScheduleId
-
string
終了するジョブ スケジュールの ID。
- callback
-
ServiceCallback<void>
コールバック
update(string, JobScheduleUpdateParameter, JobScheduleUpdateOptionalParams)
これにより、ジョブ スケジュールのすべての更新可能なプロパティが完全に置き換えられます。 たとえば、この要求で schedule プロパティが指定されていない場合、Batch サービスは既存のスケジュールを削除します。 ジョブ スケジュールに対する変更は、更新が行われた後にスケジュールによって作成されたジョブにのみ影響します。現在実行中のジョブは影響を受けません。
function update(jobScheduleId: string, jobScheduleUpdateParameter: JobScheduleUpdateParameter, options?: JobScheduleUpdateOptionalParams): Promise<JobScheduleUpdateResponse>パラメーター
- jobScheduleId
-
string
更新するジョブ スケジュールの ID。
- jobScheduleUpdateParameter
- JobScheduleUpdateParameter
要求のパラメーター。
- options
- JobScheduleUpdateOptionalParams
省略可能なパラメーター
戻り値
Promise<JobScheduleUpdateResponse>
Promise<Models.JobScheduleUpdateResponse応答>
update(string, JobScheduleUpdateParameter, JobScheduleUpdateOptionalParams, ServiceCallback<void>)
function update(jobScheduleId: string, jobScheduleUpdateParameter: JobScheduleUpdateParameter, options: JobScheduleUpdateOptionalParams, callback: ServiceCallback<void>)パラメーター
- jobScheduleId
-
string
更新するジョブ スケジュールの ID。
- jobScheduleUpdateParameter
- JobScheduleUpdateParameter
要求のパラメーター。
- options
- JobScheduleUpdateOptionalParams
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
update(string, JobScheduleUpdateParameter, ServiceCallback<void>)
function update(jobScheduleId: string, jobScheduleUpdateParameter: JobScheduleUpdateParameter, callback: ServiceCallback<void>)パラメーター
- jobScheduleId
-
string
更新するジョブ スケジュールの ID。
- jobScheduleUpdateParameter
- JobScheduleUpdateParameter
要求のパラメーター。
- callback
-
ServiceCallback<void>
コールバック