/// <summary> /// Initializes a new instance of the CloudTask class. /// </summary> /// <param name="id">A string that uniquely identifies the Task within /// the Job.</param> /// <param name="displayName">A display name for the Task.</param> /// <param name="url">The URL of the Task.</param> /// <param name="eTag">The ETag of the Task.</param> /// <param name="lastModified">The last modified time of the /// Task.</param> /// <param name="creationTime">The creation time of the Task.</param> /// <param name="exitConditions">How the Batch service should respond /// when the Task completes.</param> /// <param name="state">The current state of the Task.</param> /// <param name="stateTransitionTime">The time at which the Task /// entered its current state.</param> /// <param name="previousState">The previous state of the Task.</param> /// <param name="previousStateTransitionTime">The time at which the /// Task entered its previous state.</param> /// <param name="commandLine">The command line of the Task.</param> /// <param name="containerSettings">The settings for the container /// under which the Task runs.</param> /// <param name="resourceFiles">A list of files that the Batch service /// will download to the Compute Node before running the command /// line.</param> /// <param name="outputFiles">A list of files that the Batch service /// will upload from the Compute Node after running the command /// line.</param> /// <param name="environmentSettings">A list of environment variable /// settings for the Task.</param> /// <param name="affinityInfo">A locality hint that can be used by the /// Batch service to select a Compute Node on which to start the new /// Task.</param> /// <param name="constraints">The execution constraints that apply to /// this Task.</param> /// <param name="requiredSlots">The number of scheduling slots that the /// Task required to run.</param> /// <param name="userIdentity">The user identity under which the Task /// runs.</param> /// <param name="executionInfo">Information about the execution of the /// Task.</param> /// <param name="nodeInfo">Information about the Compute Node on which /// the Task ran.</param> /// <param name="multiInstanceSettings">An object that indicates that /// the Task is a multi-instance Task, and contains information about /// how to run the multi-instance Task.</param> /// <param name="stats">Resource usage statistics for the Task.</param> /// <param name="dependsOn">The Tasks that this Task depends /// on.</param> /// <param name="applicationPackageReferences">A list of Packages that /// the Batch service will deploy to the Compute Node before running /// the command line.</param> /// <param name="authenticationTokenSettings">The settings for an /// authentication token that the Task can use to perform Batch service /// operations.</param> public CloudTask(string id = default(string), string displayName = default(string), string url = default(string), string eTag = default(string), System.DateTime?lastModified = default(System.DateTime?), System.DateTime?creationTime = default(System.DateTime?), ExitConditions exitConditions = default(ExitConditions), TaskState?state = default(TaskState?), System.DateTime?stateTransitionTime = default(System.DateTime?), TaskState?previousState = default(TaskState?), System.DateTime?previousStateTransitionTime = default(System.DateTime?), string commandLine = default(string), TaskContainerSettings containerSettings = default(TaskContainerSettings), IList <ResourceFile> resourceFiles = default(IList <ResourceFile>), IList <OutputFile> outputFiles = default(IList <OutputFile>), IList <EnvironmentSetting> environmentSettings = default(IList <EnvironmentSetting>), AffinityInformation affinityInfo = default(AffinityInformation), TaskConstraints constraints = default(TaskConstraints), int?requiredSlots = default(int?), UserIdentity userIdentity = default(UserIdentity), TaskExecutionInformation executionInfo = default(TaskExecutionInformation), ComputeNodeInformation nodeInfo = default(ComputeNodeInformation), MultiInstanceSettings multiInstanceSettings = default(MultiInstanceSettings), TaskStatistics stats = default(TaskStatistics), TaskDependencies dependsOn = default(TaskDependencies), IList <ApplicationPackageReference> applicationPackageReferences = default(IList <ApplicationPackageReference>), AuthenticationTokenSettings authenticationTokenSettings = default(AuthenticationTokenSettings)) { Id = id; DisplayName = displayName; Url = url; ETag = eTag; LastModified = lastModified; CreationTime = creationTime; ExitConditions = exitConditions; State = state; StateTransitionTime = stateTransitionTime; PreviousState = previousState; PreviousStateTransitionTime = previousStateTransitionTime; CommandLine = commandLine; ContainerSettings = containerSettings; ResourceFiles = resourceFiles; OutputFiles = outputFiles; EnvironmentSettings = environmentSettings; AffinityInfo = affinityInfo; Constraints = constraints; RequiredSlots = requiredSlots; UserIdentity = userIdentity; ExecutionInfo = executionInfo; NodeInfo = nodeInfo; MultiInstanceSettings = multiInstanceSettings; Stats = stats; DependsOn = dependsOn; ApplicationPackageReferences = applicationPackageReferences; AuthenticationTokenSettings = authenticationTokenSettings; CustomInit(); }
/// <summary> /// Initializes a new instance of the StartTask class. /// </summary> /// <param name="commandLine">The command line of the /// StartTask.</param> /// <param name="containerSettings">The settings for the container /// under which the StartTask runs.</param> /// <param name="resourceFiles">A list of files that the Batch service /// will download to the Compute Node before running the command line. /// 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.</param> /// <param name="environmentSettings">A list of environment variable /// settings for the StartTask.</param> /// <param name="userIdentity">The user identity under which the /// StartTask runs.</param> /// <param name="maxTaskRetryCount">The maximum number of times the /// Task may be retried.</param> /// <param name="waitForSuccess">Whether the Batch service should wait /// for the StartTask to complete successfully (that is, to exit with /// exit code 0) before scheduling any Tasks on the Compute /// Node.</param> public StartTask(string commandLine, TaskContainerSettings containerSettings = default(TaskContainerSettings), IList <ResourceFile> resourceFiles = default(IList <ResourceFile>), IList <EnvironmentSetting> environmentSettings = default(IList <EnvironmentSetting>), UserIdentity userIdentity = default(UserIdentity), int?maxTaskRetryCount = default(int?), bool?waitForSuccess = default(bool?)) { CommandLine = commandLine; ContainerSettings = containerSettings; ResourceFiles = resourceFiles; EnvironmentSettings = environmentSettings; UserIdentity = userIdentity; MaxTaskRetryCount = maxTaskRetryCount; WaitForSuccess = waitForSuccess; CustomInit(); }
/// <summary> /// Initializes a new instance of the JobReleaseTask class. /// </summary> /// <param name="commandLine">The command line of the Job Release /// task.</param> /// <param name="id">A string that uniquely identifies the Job Release /// task within the job.</param> /// <param name="containerSettings">The settings for the container /// under which the Job Release task runs.</param> /// <param name="resourceFiles">A list of files that the Batch service /// will download to the compute node before running the command line. /// 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.</param> /// <param name="environmentSettings">A list of environment variable /// settings for the Job Release task.</param> /// <param name="maxWallClockTime">The maximum elapsed time that the /// Job Release task may run on a given compute node, measured from the /// time the task starts. If the task does not complete within the time /// limit, the Batch service terminates it. The default value is 15 /// minutes. You may not specify a timeout longer than 15 minutes. If /// you do, the Batch service rejects it with an error; if you are /// calling the REST API directly, the HTTP status code is 400 (Bad /// Request).</param> /// <param name="retentionTime">The minimum time to retain the task /// directory for the Job Release task on the compute node. After this /// time, the Batch service may delete the task directory and all its /// contents.</param> /// <param name="userIdentity">The user identity under which the Job /// Release task runs.</param> public JobReleaseTask(string commandLine, string id = default(string), TaskContainerSettings containerSettings = default(TaskContainerSettings), IList <ResourceFile> resourceFiles = default(IList <ResourceFile>), IList <EnvironmentSetting> environmentSettings = default(IList <EnvironmentSetting>), System.TimeSpan?maxWallClockTime = default(System.TimeSpan?), System.TimeSpan?retentionTime = default(System.TimeSpan?), UserIdentity userIdentity = default(UserIdentity)) { Id = id; CommandLine = commandLine; ContainerSettings = containerSettings; ResourceFiles = resourceFiles; EnvironmentSettings = environmentSettings; MaxWallClockTime = maxWallClockTime; RetentionTime = retentionTime; UserIdentity = userIdentity; CustomInit(); }
/// <summary> /// Initializes a new instance of the JobPreparationTask class. /// </summary> /// <param name="commandLine">The command line of the Job Preparation /// task.</param> /// <param name="id">A string that uniquely identifies the Job /// Preparation task within the job.</param> /// <param name="containerSettings">The settings for the container /// under which the Job Preparation task runs.</param> /// <param name="resourceFiles">A list of files that the Batch service /// will download to the compute node before running the command /// line.</param> /// <param name="environmentSettings">A list of environment variable /// settings for the Job Preparation task.</param> /// <param name="constraints">Constraints that apply to the Job /// Preparation task.</param> /// <param name="waitForSuccess">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.</param> /// <param name="userIdentity">The user identity under which the Job /// Preparation task runs.</param> /// <param name="rerunOnNodeRebootAfterSuccess">Whether the Batch /// service should rerun the Job Preparation task after a compute node /// reboots.</param> public JobPreparationTask(string commandLine, string id = default(string), TaskContainerSettings containerSettings = default(TaskContainerSettings), IList <ResourceFile> resourceFiles = default(IList <ResourceFile>), IList <EnvironmentSetting> environmentSettings = default(IList <EnvironmentSetting>), TaskConstraints constraints = default(TaskConstraints), bool?waitForSuccess = default(bool?), UserIdentity userIdentity = default(UserIdentity), bool?rerunOnNodeRebootAfterSuccess = default(bool?)) { Id = id; CommandLine = commandLine; ContainerSettings = containerSettings; ResourceFiles = resourceFiles; EnvironmentSettings = environmentSettings; Constraints = constraints; WaitForSuccess = waitForSuccess; UserIdentity = userIdentity; RerunOnNodeRebootAfterSuccess = rerunOnNodeRebootAfterSuccess; CustomInit(); }
/// <summary> /// Initializes a new instance of the JobManagerTask class. /// </summary> /// <param name="id">A string that uniquely identifies the Job Manager /// task within the job.</param> /// <param name="commandLine">The command line of the Job Manager /// task.</param> /// <param name="displayName">The display name of the Job Manager /// task.</param> /// <param name="containerSettings">The settings for the container /// under which the Job Manager task runs.</param> /// <param name="resourceFiles">A list of files that the Batch service /// will download to the compute node before running the command /// line.</param> /// <param name="outputFiles">A list of files that the Batch service /// will upload from the compute node after running the command /// line.</param> /// <param name="environmentSettings">A list of environment variable /// settings for the Job Manager task.</param> /// <param name="constraints">Constraints that apply to the Job Manager /// task.</param> /// <param name="killJobOnCompletion">Whether completion of the Job /// Manager task signifies completion of the entire job.</param> /// <param name="userIdentity">The user identity under which the Job /// Manager task runs.</param> /// <param name="runExclusive">Whether the Job Manager task requires /// exclusive use of the compute node where it runs.</param> /// <param name="applicationPackageReferences">A list of application /// packages that the Batch service will deploy to the compute node /// before running the command line.</param> /// <param name="authenticationTokenSettings">The settings for an /// authentication token that the task can use to perform Batch service /// operations.</param> /// <param name="allowLowPriorityNode">Whether the Job Manager task may /// run on a low-priority compute node.</param> public JobManagerTask(string id, string commandLine, string displayName = default(string), TaskContainerSettings containerSettings = default(TaskContainerSettings), IList <ResourceFile> resourceFiles = default(IList <ResourceFile>), IList <OutputFile> outputFiles = default(IList <OutputFile>), IList <EnvironmentSetting> environmentSettings = default(IList <EnvironmentSetting>), TaskConstraints constraints = default(TaskConstraints), bool?killJobOnCompletion = default(bool?), UserIdentity userIdentity = default(UserIdentity), bool?runExclusive = default(bool?), IList <ApplicationPackageReference> applicationPackageReferences = default(IList <ApplicationPackageReference>), AuthenticationTokenSettings authenticationTokenSettings = default(AuthenticationTokenSettings), bool?allowLowPriorityNode = default(bool?)) { Id = id; DisplayName = displayName; CommandLine = commandLine; ContainerSettings = containerSettings; ResourceFiles = resourceFiles; OutputFiles = outputFiles; EnvironmentSettings = environmentSettings; Constraints = constraints; KillJobOnCompletion = killJobOnCompletion; UserIdentity = userIdentity; RunExclusive = runExclusive; ApplicationPackageReferences = applicationPackageReferences; AuthenticationTokenSettings = authenticationTokenSettings; AllowLowPriorityNode = allowLowPriorityNode; CustomInit(); }
/// <summary> /// Initializes a new instance of the TaskAddParameter class. /// </summary> /// <param name="id">A string that uniquely identifies the Task within /// the Job.</param> /// <param name="commandLine">The command line of the Task.</param> /// <param name="displayName">A display name for the Task.</param> /// <param name="containerSettings">The settings for the container /// under which the Task runs.</param> /// <param name="exitConditions">How the Batch service should respond /// when the Task completes.</param> /// <param name="resourceFiles">A list of files that the Batch service /// will download to the Compute Node before running the command /// line.</param> /// <param name="outputFiles">A list of files that the Batch service /// will upload from the Compute Node after running the command /// line.</param> /// <param name="environmentSettings">A list of environment variable /// settings for the Task.</param> /// <param name="affinityInfo">A locality hint that can be used by the /// Batch service to select a Compute Node on which to start the new /// Task.</param> /// <param name="constraints">The execution constraints that apply to /// this Task.</param> /// <param name="userIdentity">The user identity under which the Task /// runs.</param> /// <param name="multiInstanceSettings">An object that indicates that /// the Task is a multi-instance Task, and contains information about /// how to run the multi-instance Task.</param> /// <param name="dependsOn">The Tasks that this Task depends /// on.</param> /// <param name="applicationPackageReferences">A list of Packages that /// the Batch service will deploy to the Compute Node before running /// the command line.</param> /// <param name="authenticationTokenSettings">The settings for an /// authentication token that the Task can use to perform Batch service /// operations.</param> public TaskAddParameter(string id, string commandLine, string displayName = default(string), TaskContainerSettings containerSettings = default(TaskContainerSettings), ExitConditions exitConditions = default(ExitConditions), IList <ResourceFile> resourceFiles = default(IList <ResourceFile>), IList <OutputFile> outputFiles = default(IList <OutputFile>), IList <EnvironmentSetting> environmentSettings = default(IList <EnvironmentSetting>), AffinityInformation affinityInfo = default(AffinityInformation), TaskConstraints constraints = default(TaskConstraints), UserIdentity userIdentity = default(UserIdentity), MultiInstanceSettings multiInstanceSettings = default(MultiInstanceSettings), TaskDependencies dependsOn = default(TaskDependencies), IList <ApplicationPackageReference> applicationPackageReferences = default(IList <ApplicationPackageReference>), AuthenticationTokenSettings authenticationTokenSettings = default(AuthenticationTokenSettings)) { Id = id; DisplayName = displayName; CommandLine = commandLine; ContainerSettings = containerSettings; ExitConditions = exitConditions; ResourceFiles = resourceFiles; OutputFiles = outputFiles; EnvironmentSettings = environmentSettings; AffinityInfo = affinityInfo; Constraints = constraints; UserIdentity = userIdentity; MultiInstanceSettings = multiInstanceSettings; DependsOn = dependsOn; ApplicationPackageReferences = applicationPackageReferences; AuthenticationTokenSettings = authenticationTokenSettings; CustomInit(); }