File: job_execution_information_py3.py

package info (click to toggle)
python-azure 20181112%2Bgit-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 407,300 kB
  • sloc: python: 717,190; makefile: 201; sh: 76
file content (73 lines) | stat: -rw-r--r-- 3,603 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# 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


class JobExecutionInformation(Model):
    """Contains information about the execution of a job in the Azure Batch
    service.

    All required parameters must be populated in order to send to Azure.

    :param start_time: Required. The start time of the job. This is the time
     at which the job was created.
    :type start_time: datetime
    :param end_time: The completion time of the job. This property is set only
     if the job is in the completed state.
    :type end_time: datetime
    :param pool_id: The ID of the pool to which this job is assigned. This
     element contains the actual pool where the job is assigned. When you get
     job details from the service, they also contain a poolInfo element, which
     contains the pool configuration data from when the job was added or
     updated. That poolInfo element may also contain a poolId element. If it
     does, the two IDs are the same. If it does not, it means the job ran on an
     auto pool, and this property contains the ID of that auto pool.
    :type pool_id: str
    :param scheduling_error: Details of any error encountered by the service
     in starting the job. This property is not set if there was no error
     starting the job.
    :type scheduling_error: ~azure.batch.models.JobSchedulingError
    :param terminate_reason: A string describing the reason the job ended.
     This property is set only if the job is in the completed state. If the
     Batch service terminates the job, it sets the reason as follows:
     JMComplete - the Job Manager task completed, and killJobOnCompletion was
     set to true. MaxWallClockTimeExpiry - the job reached its maxWallClockTime
     constraint. TerminateJobSchedule - the job ran as part of a schedule, and
     the schedule terminated. AllTasksComplete - the job's onAllTasksComplete
     attribute is set to terminatejob, and all tasks in the job are complete.
     TaskFailed - the job's onTaskFailure attribute is set to
     performExitOptionsJobAction, and a task in the job failed with an exit
     condition that specified a jobAction of terminatejob. Any other string is
     a user-defined reason specified in a call to the 'Terminate a job'
     operation.
    :type terminate_reason: str
    """

    _validation = {
        'start_time': {'required': True},
    }

    _attribute_map = {
        'start_time': {'key': 'startTime', 'type': 'iso-8601'},
        'end_time': {'key': 'endTime', 'type': 'iso-8601'},
        'pool_id': {'key': 'poolId', 'type': 'str'},
        'scheduling_error': {'key': 'schedulingError', 'type': 'JobSchedulingError'},
        'terminate_reason': {'key': 'terminateReason', 'type': 'str'},
    }

    def __init__(self, *, start_time, end_time=None, pool_id: str=None, scheduling_error=None, terminate_reason: str=None, **kwargs) -> None:
        super(JobExecutionInformation, self).__init__(**kwargs)
        self.start_time = start_time
        self.end_time = end_time
        self.pool_id = pool_id
        self.scheduling_error = scheduling_error
        self.terminate_reason = terminate_reason