Package com.azure.compute.batch.models

Class BatchJobPreparationTask

java.lang.Object
com.azure.compute.batch.models.BatchJobPreparationTask
All Implemented Interfaces:
com.azure.json.JsonSerializable<BatchJobPreparationTask>
public final class BatchJobPreparationTask extends Object implements com.azure.json.JsonSerializable<BatchJobPreparationTask>
A Job Preparation Task to run before any Tasks of the Job on any given Compute Node. You can use Job Preparation to prepare a Node to run Tasks for the Job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the Tasks in the Job. The Job Preparation Task can download these common resource files to the shared location on the Node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local service on the Node so that all Tasks of that Job can communicate with it. If the Job Preparation Task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run Tasks of this Job on the Node. The Compute Node remains ineligible to run Tasks of this Job until it is reimaged. The Compute Node remains active and can be used for other Jobs. The Job Preparation Task can run multiple times on the same Node. Therefore, you should write the Job Preparation Task to handle re-execution. If the Node is rebooted, the Job Preparation Task is run again on the Compute Node before scheduling any other Task of the Job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation Task did not previously complete. If the Node is reimaged, the Job Preparation Task is run again before scheduling any Task of the Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.

  • Constructor Details

    • BatchJobPreparationTask

      public BatchJobPreparationTask(String commandLine)
      Creates an instance of BatchJobPreparationTask class.
      Parameters:
      commandLine - the commandLine value to set.

  • Method Details

    • getId

      public String getId()
      Get the id property: A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict).
      Returns:
      the id value.

    • setId

      public BatchJobPreparationTask setId(String id)
      Set the id property: A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict).
      Parameters:
      id - the id value to set.
      Returns:
      the BatchJobPreparationTask object itself.

    • getCommandLine

      public String getCommandLine()
      Get the commandLine property: The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).
      Returns:
      the commandLine value.

    • getContainerSettings

      public BatchTaskContainerSettings getContainerSettings()
      Get the containerSettings property: The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files.
      Returns:
      the containerSettings value.

    • setContainerSettings

      public BatchJobPreparationTask setContainerSettings(BatchTaskContainerSettings containerSettings)
      Set the containerSettings property: The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files.
      Parameters:
      containerSettings - the containerSettings value to set.
      Returns:
      the BatchJobPreparationTask object itself.

    • getResourceFiles

      public List<ResourceFile> getResourceFiles()
      Get the resourceFiles property: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
      Returns:
      the resourceFiles value.

    • setResourceFiles

      public BatchJobPreparationTask setResourceFiles(List<ResourceFile> resourceFiles)
      Set the resourceFiles property: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.
      Parameters:
      resourceFiles - the resourceFiles value to set.
      Returns:
      the BatchJobPreparationTask object itself.

    • getEnvironmentSettings

      public List<EnvironmentSetting> getEnvironmentSettings()
      Get the environmentSettings property: A list of environment variable settings for the Job Preparation Task.
      Returns:
      the environmentSettings value.

    • setEnvironmentSettings

      public BatchJobPreparationTask setEnvironmentSettings(List<EnvironmentSetting> environmentSettings)
      Set the environmentSettings property: A list of environment variable settings for the Job Preparation Task.
      Parameters:
      environmentSettings - the environmentSettings value to set.
      Returns:
      the BatchJobPreparationTask object itself.

    • getConstraints

      public BatchTaskConstraints getConstraints()
      Get the constraints property: Constraints that apply to the Job Preparation Task.
      Returns:
      the constraints value.

    • setConstraints

      public BatchJobPreparationTask setConstraints(BatchTaskConstraints constraints)
      Set the constraints property: Constraints that apply to the Job Preparation Task.
      Parameters:
      constraints - the constraints value to set.
      Returns:
      the BatchJobPreparationTask object itself.

    • isWaitForSuccess

      public Boolean isWaitForSuccess()
      Get the waitForSuccess property: Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true.
      Returns:
      the waitForSuccess value.

    • setWaitForSuccess

      public BatchJobPreparationTask setWaitForSuccess(Boolean waitForSuccess)
      Set the waitForSuccess property: Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true.
      Parameters:
      waitForSuccess - the waitForSuccess value to set.
      Returns:
      the BatchJobPreparationTask object itself.

    • getUserIdentity

      public UserIdentity getUserIdentity()
      Get the userIdentity property: The user identity under which the Job Preparation Task runs. If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes.
      Returns:
      the userIdentity value.

    • setUserIdentity

      public BatchJobPreparationTask setUserIdentity(UserIdentity userIdentity)
      Set the userIdentity property: The user identity under which the Job Preparation Task runs. If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes.
      Parameters:
      userIdentity - the userIdentity value to set.
      Returns:
      the BatchJobPreparationTask object itself.

    • isRerunOnNodeRebootAfterSuccess

      public Boolean isRerunOnNodeRebootAfterSuccess()
      Get the rerunOnNodeRebootAfterSuccess property: Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true.
      Returns:
      the rerunOnNodeRebootAfterSuccess value.

    • setRerunOnNodeRebootAfterSuccess

      public BatchJobPreparationTask setRerunOnNodeRebootAfterSuccess(Boolean rerunOnNodeRebootAfterSuccess)
      Set the rerunOnNodeRebootAfterSuccess property: Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true.
      Parameters:
      rerunOnNodeRebootAfterSuccess - the rerunOnNodeRebootAfterSuccess value to set.
      Returns:
      the BatchJobPreparationTask object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<BatchJobPreparationTask>
      Throws:
      IOException

    • fromJson

      public static BatchJobPreparationTask fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of BatchJobPreparationTask from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of BatchJobPreparationTask if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the BatchJobPreparationTask.