Source code for azure.batch.models.job_add_parameter

# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
#
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
# --------------------------------------------------------------------------

from msrest.serialization import Model


[docs]class JobAddParameter(Model): """An Azure Batch job to add. :param id: A string that uniquely identifies the job within the account. The id can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. It is common to use a GUID for the id. :type id: str :param display_name: The display name for the job. :type display_name: str :param priority: The priority of the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. :type priority: int :param constraints: The execution constraints for the job. :type constraints: :class:`JobConstraints <azure.batch.models.JobConstraints>` :param job_manager_task: Details of a Job Manager task to be launched when the job is started. :type job_manager_task: :class:`JobManagerTask <azure.batch.models.JobManagerTask>` :param job_preparation_task: The Job Preparation task. :type job_preparation_task: :class:`JobPreparationTask <azure.batch.models.JobPreparationTask>` :param job_release_task: The Job Release task. :type job_release_task: :class:`JobReleaseTask <azure.batch.models.JobReleaseTask>` :param common_environment_settings: The list of common environment variable settings. These environment variables are set for all tasks in the job (including the Job Manager, Job Preparation and Job Release tasks). :type common_environment_settings: list of :class:`EnvironmentSetting <azure.batch.models.EnvironmentSetting>` :param pool_info: The pool on which the Batch service runs the job's tasks. :type pool_info: :class:`PoolInformation <azure.batch.models.PoolInformation>` :param on_all_tasks_complete: The action the Batch service should take when all tasks in the job are in the completed state. Possible values include: 'noAction', 'terminateJob' :type on_all_tasks_complete: str or :class:`OnAllTasksComplete <azure.batch.models.OnAllTasksComplete>` :param on_task_failure: The action the Batch service should take when any task in the job fails. A task is considered to have failed if it completes with a non-zero exit code and has exhausted its retry count, or if it had a scheduling error. Possible values include: 'noAction', 'performExitOptionsJobAction' :type on_task_failure: str or :class:`OnTaskFailure <azure.batch.models.OnTaskFailure>` :param metadata: A list of name-value pairs associated with the job as metadata. :type metadata: list of :class:`MetadataItem <azure.batch.models.MetadataItem>` :param uses_task_dependencies: The flag that determines if this job will use tasks with dependencies. :type uses_task_dependencies: bool """ _validation = { 'id': {'required': True}, 'pool_info': {'required': True}, } _attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'display_name': {'key': 'displayName', 'type': 'str'}, 'priority': {'key': 'priority', 'type': 'int'}, 'constraints': {'key': 'constraints', 'type': 'JobConstraints'}, 'job_manager_task': {'key': 'jobManagerTask', 'type': 'JobManagerTask'}, 'job_preparation_task': {'key': 'jobPreparationTask', 'type': 'JobPreparationTask'}, 'job_release_task': {'key': 'jobReleaseTask', 'type': 'JobReleaseTask'}, 'common_environment_settings': {'key': 'commonEnvironmentSettings', 'type': '[EnvironmentSetting]'}, 'pool_info': {'key': 'poolInfo', 'type': 'PoolInformation'}, 'on_all_tasks_complete': {'key': 'onAllTasksComplete', 'type': 'OnAllTasksComplete'}, 'on_task_failure': {'key': 'onTaskFailure', 'type': 'OnTaskFailure'}, 'metadata': {'key': 'metadata', 'type': '[MetadataItem]'}, 'uses_task_dependencies': {'key': 'usesTaskDependencies', 'type': 'bool'}, } def __init__(self, id, pool_info, display_name=None, priority=None, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, on_all_tasks_complete=None, on_task_failure=None, metadata=None, uses_task_dependencies=None): self.id = id self.display_name = display_name self.priority = priority self.constraints = constraints self.job_manager_task = job_manager_task self.job_preparation_task = job_preparation_task self.job_release_task = job_release_task self.common_environment_settings = common_environment_settings self.pool_info = pool_info self.on_all_tasks_complete = on_all_tasks_complete self.on_task_failure = on_task_failure self.metadata = metadata self.uses_task_dependencies = uses_task_dependencies