DeleteJob interface
Methods
| delete(Delete |
Deleting a Job also deletes all Tasks that are part of that Job, and all Job statistics. This also overrides the retention period for Task data; that is, if the Job contains Tasks which are still retained on Compute Nodes, the Batch services deletes those Tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the Job to the deleting state. All update operations on a Job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the Job is being deleted. |
| get(Get |
Gets information about the specified Job. |
| patch(Update |
This replaces only the Job properties specified in the request. For example, if the Job has constraints, and a request does not specify the constraints element, then the Job keeps the existing constraints. |
| put(Replace |
This fully replaces all the updatable properties of the Job. For example, if the Job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints. |
Method Details
delete(DeleteJobParameters)
Deleting a Job also deletes all Tasks that are part of that Job, and all Job statistics. This also overrides the retention period for Task data; that is, if the Job contains Tasks which are still retained on Compute Nodes, the Batch services deletes those Tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the Job to the deleting state. All update operations on a Job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the Job is being deleted.
function delete(options?: DeleteJobParameters): StreamableMethod<DeleteJob202Response | DeleteJobDefaultResponse>Parameters
- options
- DeleteJobParameters
Returns
get(GetJobParameters)
Gets information about the specified Job.
function get(options?: GetJobParameters): StreamableMethod<GetJob200Response | GetJobDefaultResponse>Parameters
- options
- GetJobParameters
Returns
patch(UpdateJobParameters)
This replaces only the Job properties specified in the request. For example, if the Job has constraints, and a request does not specify the constraints element, then the Job keeps the existing constraints.
function patch(options: UpdateJobParameters): StreamableMethod<UpdateJob200Response | UpdateJobDefaultResponse>Parameters
- options
- UpdateJobParameters
Returns
put(ReplaceJobParameters)
This fully replaces all the updatable properties of the Job. For example, if the Job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.
function put(options: ReplaceJobParameters): StreamableMethod<ReplaceJob200Response | ReplaceJobDefaultResponse>Parameters
- options
- ReplaceJobParameters
