< Summary

Class:Microsoft.Azure.Batch.Protocol.Models.JobPreparationTaskExecutionInformation
Assembly:Microsoft.Azure.Batch
File(s):C:\Git\azure-sdk-for-net\sdk\batch\Microsoft.Azure.Batch\src\GeneratedProtocol\Models\JobPreparationTaskExecutionInformation.cs
Covered lines:13
Uncovered lines:13
Coverable lines:26
Total lines:206
Line coverage:50% (13 of 26)
Covered branches:0
Total branches:0

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
.ctor()-100%100%
.ctor(...)-0%100%
get_StartTime()-100%100%
get_EndTime()-100%100%
get_State()-100%100%
get_TaskRootDirectory()-100%100%
get_TaskRootDirectoryUrl()-100%100%
get_ExitCode()-100%100%
get_ContainerInfo()-100%100%
get_FailureInfo()-100%100%
get_RetryCount()-100%100%
get_LastRetryTime()-100%100%
get_Result()-100%100%

File(s)

C:\Git\azure-sdk-for-net\sdk\batch\Microsoft.Azure.Batch\src\GeneratedProtocol\Models\JobPreparationTaskExecutionInformation.cs

#LineLine coverage
 1// <auto-generated>
 2// Copyright (c) Microsoft Corporation. All rights reserved.
 3// Licensed under the MIT License. See License.txt in the project root for
 4// license information.
 5//
 6// Code generated by Microsoft (R) AutoRest Code Generator.
 7// Changes may cause incorrect behavior and will be lost if the code is
 8// regenerated.
 9// </auto-generated>
 10
 11namespace Microsoft.Azure.Batch.Protocol.Models
 12{
 13    using Newtonsoft.Json;
 14    using System.Linq;
 15
 16    /// <summary>
 17    /// Contains information about the execution of a Job Preparation Task on a
 18    /// Compute Node.
 19    /// </summary>
 20    public partial class JobPreparationTaskExecutionInformation
 21    {
 22        /// <summary>
 23        /// Initializes a new instance of the
 24        /// JobPreparationTaskExecutionInformation class.
 25        /// </summary>
 49126        public JobPreparationTaskExecutionInformation()
 27        {
 28            CustomInit();
 49129        }
 30
 31        /// <summary>
 32        /// Initializes a new instance of the
 33        /// JobPreparationTaskExecutionInformation class.
 34        /// </summary>
 35        /// <param name="startTime">The time at which the Task started
 36        /// running.</param>
 37        /// <param name="state">The current state of the Job Preparation Task
 38        /// on the Compute Node.</param>
 39        /// <param name="retryCount">The number of times the Task has been
 40        /// retried by the Batch service. Task application failures (non-zero
 41        /// exit code) are retried, pre-processing errors (the Task could not
 42        /// be run) and file upload errors are not retried. The Batch service
 43        /// will retry the Task up to the limit specified by the
 44        /// constraints.</param>
 45        /// <param name="endTime">The time at which the Job Preparation Task
 46        /// completed.</param>
 47        /// <param name="taskRootDirectory">The root directory of the Job
 48        /// Preparation Task on the Compute Node. You can use this path to
 49        /// retrieve files created by the Task, such as log files.</param>
 50        /// <param name="taskRootDirectoryUrl">The URL to the root directory of
 51        /// the Job Preparation Task on the Compute Node.</param>
 52        /// <param name="exitCode">The exit code of the program specified on
 53        /// the Task command line.</param>
 54        /// <param name="containerInfo">Information about the container under
 55        /// which the Task is executing.</param>
 56        /// <param name="failureInfo">Information describing the Task failure,
 57        /// if any.</param>
 58        /// <param name="lastRetryTime">The most recent time at which a retry
 59        /// of the Job Preparation Task started running.</param>
 60        /// <param name="result">The result of the Task execution.</param>
 061        public JobPreparationTaskExecutionInformation(System.DateTime startTime, JobPreparationTaskState state, int retr
 62        {
 063            StartTime = startTime;
 064            EndTime = endTime;
 065            State = state;
 066            TaskRootDirectory = taskRootDirectory;
 067            TaskRootDirectoryUrl = taskRootDirectoryUrl;
 068            ExitCode = exitCode;
 069            ContainerInfo = containerInfo;
 070            FailureInfo = failureInfo;
 071            RetryCount = retryCount;
 072            LastRetryTime = lastRetryTime;
 073            Result = result;
 74            CustomInit();
 075        }
 76
 77        /// <summary>
 78        /// An initialization method that performs custom operations like setting defaults
 79        /// </summary>
 80        partial void CustomInit();
 81
 82        /// <summary>
 83        /// Gets or sets the time at which the Task started running.
 84        /// </summary>
 85        /// <remarks>
 86        /// If the Task has been restarted or retried, this is the most recent
 87        /// time at which the Task started running.
 88        /// </remarks>
 89        [JsonProperty(PropertyName = "startTime")]
 120890        public System.DateTime StartTime { get; set; }
 91
 92        /// <summary>
 93        /// Gets or sets the time at which the Job Preparation Task completed.
 94        /// </summary>
 95        /// <remarks>
 96        /// This property is set only if the Task is in the Completed state.
 97        /// </remarks>
 98        [JsonProperty(PropertyName = "endTime")]
 120899        public System.DateTime? EndTime { get; set; }
 100
 101        /// <summary>
 102        /// Gets or sets the current state of the Job Preparation Task on the
 103        /// Compute Node.
 104        /// </summary>
 105        /// <remarks>
 106        /// Possible values include: 'running', 'completed'
 107        /// </remarks>
 108        [JsonProperty(PropertyName = "state")]
 1230109        public JobPreparationTaskState State { get; set; }
 110
 111        /// <summary>
 112        /// Gets or sets the root directory of the Job Preparation Task on the
 113        /// Compute Node. You can use this path to retrieve files created by
 114        /// the Task, such as log files.
 115        /// </summary>
 116        [JsonProperty(PropertyName = "taskRootDirectory")]
 1221117        public string TaskRootDirectory { get; set; }
 118
 119        /// <summary>
 120        /// Gets or sets the URL to the root directory of the Job Preparation
 121        /// Task on the Compute Node.
 122        /// </summary>
 123        [JsonProperty(PropertyName = "taskRootDirectoryUrl")]
 1218124        public string TaskRootDirectoryUrl { get; set; }
 125
 126        /// <summary>
 127        /// Gets or sets the exit code of the program specified on the Task
 128        /// command line.
 129        /// </summary>
 130        /// <remarks>
 131        /// This parameter is returned only if the Task is in the completed
 132        /// state. The exit code for a process reflects the specific convention
 133        /// implemented by the application developer for that process. If you
 134        /// use the exit code value to make decisions in your code, be sure
 135        /// that you know the exit code convention used by the application
 136        /// process. Note that the exit code may also be generated by the
 137        /// Compute Node operating system, such as when a process is forcibly
 138        /// terminated.
 139        /// </remarks>
 140        [JsonProperty(PropertyName = "exitCode")]
 1230141        public int? ExitCode { get; set; }
 142
 143        /// <summary>
 144        /// Gets or sets information about the container under which the Task
 145        /// is executing.
 146        /// </summary>
 147        /// <remarks>
 148        /// This property is set only if the Task runs in a container context.
 149        /// </remarks>
 150        [JsonProperty(PropertyName = "containerInfo")]
 1203151        public TaskContainerExecutionInformation ContainerInfo { get; set; }
 152
 153        /// <summary>
 154        /// Gets or sets information describing the Task failure, if any.
 155        /// </summary>
 156        /// <remarks>
 157        /// This property is set only if the Task is in the completed state and
 158        /// encountered a failure.
 159        /// </remarks>
 160        [JsonProperty(PropertyName = "failureInfo")]
 1200161        public TaskFailureInformation FailureInfo { get; set; }
 162
 163        /// <summary>
 164        /// Gets or sets the number of times the Task has been retried by the
 165        /// Batch service. Task application failures (non-zero exit code) are
 166        /// retried, pre-processing errors (the Task could not be run) and file
 167        /// upload errors are not retried. The Batch service will retry the
 168        /// Task up to the limit specified by the constraints.
 169        /// </summary>
 170        /// <remarks>
 171        /// Task application failures (non-zero exit code) are retried,
 172        /// pre-processing errors (the Task could not be run) and file upload
 173        /// errors are not retried. The Batch service will retry the Task up to
 174        /// the limit specified by the constraints.
 175        /// </remarks>
 176        [JsonProperty(PropertyName = "retryCount")]
 1221177        public int RetryCount { get; set; }
 178
 179        /// <summary>
 180        /// Gets or sets the most recent time at which a retry of the Job
 181        /// Preparation Task started running.
 182        /// </summary>
 183        /// <remarks>
 184        /// This property is set only if the Task was retried (i.e. retryCount
 185        /// is nonzero). If present, this is typically the same as startTime,
 186        /// but may be different if the Task has been restarted for reasons
 187        /// other than retry; for example, if the Compute Node was rebooted
 188        /// during a retry, then the startTime is updated but the lastRetryTime
 189        /// is not.
 190        /// </remarks>
 191        [JsonProperty(PropertyName = "lastRetryTime")]
 1214192        public System.DateTime? LastRetryTime { get; set; }
 193
 194        /// <summary>
 195        /// Gets or sets the result of the Task execution.
 196        /// </summary>
 197        /// <remarks>
 198        /// If the value is 'failed', then the details of the failure can be
 199        /// found in the failureInfo property. Possible values include:
 200        /// 'success', 'failure'
 201        /// </remarks>
 202        [JsonProperty(PropertyName = "result")]
 1218203        public TaskExecutionResult? Result { get; set; }
 204
 205    }
 206}
Generated by: ReportGenerator 4.6.4.0
8/12/2020 - 3:47:12 PM
GitHub | www.palmmedia.de

Methods/Properties

.ctor()
.ctor(...)
get_StartTime()
get_EndTime()
get_State()
get_TaskRootDirectory()
get_TaskRootDirectoryUrl()
get_ExitCode()
get_ContainerInfo()
get_FailureInfo()
get_RetryCount()
get_LastRetryTime()
get_Result()