JobScheduleExists interface
Methods
| delete(Delete |
When you delete a Job Schedule, this also deletes all Jobs and Tasks under that schedule. When Tasks are deleted, all the files in their working directories on the Compute Nodes are also deleted (the retention period is ignored). The Job Schedule statistics are no longer accessible once the Job Schedule is deleted, though they are still counted towards Account lifetime statistics. |
| get(Get |
Gets information about the specified Job Schedule. |
| head(Job |
Checks the specified Job Schedule exists. |
| patch(Update |
This replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected. |
| put(Replace |
This fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected. |
Method Details
delete(DeleteJobScheduleParameters)
When you delete a Job Schedule, this also deletes all Jobs and Tasks under that schedule. When Tasks are deleted, all the files in their working directories on the Compute Nodes are also deleted (the retention period is ignored). The Job Schedule statistics are no longer accessible once the Job Schedule is deleted, though they are still counted towards Account lifetime statistics.
function delete(options?: DeleteJobScheduleParameters): StreamableMethod<DeleteJobSchedule202Response | DeleteJobScheduleDefaultResponse>Parameters
- options
- DeleteJobScheduleParameters
Returns
get(GetJobScheduleParameters)
Gets information about the specified Job Schedule.
function get(options?: GetJobScheduleParameters): StreamableMethod<GetJobSchedule200Response | GetJobScheduleDefaultResponse>Parameters
- options
- GetJobScheduleParameters
Returns
head(JobScheduleExistsParameters)
Checks the specified Job Schedule exists.
function head(options?: JobScheduleExistsParameters): StreamableMethod<JobScheduleExists200Response | JobScheduleExists404Response | JobScheduleExistsDefaultResponse>Parameters
- options
- JobScheduleExistsParameters
Returns
patch(UpdateJobScheduleParameters)
This replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.
function patch(options: UpdateJobScheduleParameters): StreamableMethod<UpdateJobSchedule200Response | UpdateJobScheduleDefaultResponse>Parameters
- options
- UpdateJobScheduleParameters
Returns
put(ReplaceJobScheduleParameters)
This fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.
function put(options: ReplaceJobScheduleParameters): StreamableMethod<ReplaceJobSchedule200Response | ReplaceJobScheduleDefaultResponse>Parameters
- options
- ReplaceJobScheduleParameters
