JobPreparationTaskExecutionInformation.cs

// <auto-generated>
// 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.
// </auto-generated>

namespace Microsoft.Azure.Batch.Protocol.Models
{
    using Newtonsoft.Json;
    using System.Linq;

    /// <summary>
    /// Contains information about the execution of a Job Preparation Task on a
    /// Compute Node.
    /// </summary>
    public partial class JobPreparationTaskExecutionInformation
    {
        /// <summary>
        /// Initializes a new instance of the
        /// JobPreparationTaskExecutionInformation class.
        /// </summary>
        public JobPreparationTaskExecutionInformation()
        {
            CustomInit();
        }

        /// <summary>
        /// Initializes a new instance of the
        /// JobPreparationTaskExecutionInformation class.
        /// </summary>
        /// <param name="startTime">The time at which the Task started
        /// running.</param>
        /// <param name="state">The current state of the Job Preparation Task
        /// on the Compute Node.</param>
        /// <param name="retryCount">The number of times the Task has been
        /// retried by the Batch service. Task application failures (non-zero
        /// exit code) are retried, pre-processing errors (the Task could not
        /// be run) and file upload errors are not retried. The Batch service
        /// will retry the Task up to the limit specified by the
        /// constraints.</param>
        /// <param name="endTime">The time at which the Job Preparation Task
        /// completed.</param>
        /// <param name="taskRootDirectory">The root directory of the Job
        /// Preparation Task on the Compute Node. You can use this path to
        /// retrieve files created by the Task, such as log files.</param>
        /// <param name="taskRootDirectoryUrl">The URL to the root directory of
        /// the Job Preparation Task on the Compute Node.</param>
        /// <param name="exitCode">The exit code of the program specified on
        /// the Task command line.</param>
        /// <param name="containerInfo">Information about the container under
        /// which the Task is executing.</param>
        /// <param name="failureInfo">Information describing the Task failure,
        /// if any.</param>
        /// <param name="lastRetryTime">The most recent time at which a retry
        /// of the Job Preparation Task started running.</param>
        /// <param name="result">The result of the Task execution.</param>
        public JobPreparationTaskExecutionInformation(System.DateTime startTime, JobPreparationTaskState state, int retryCount, System.DateTime? endTime = default(System.DateTime?), string taskRootDirectory = default(string), string taskRootDirectoryUrl = default(string), int? exitCode = default(int?), TaskContainerExecutionInformation containerInfo = default(TaskContainerExecutionInformation), TaskFailureInformation failureInfo = default(TaskFailureInformation), System.DateTime? lastRetryTime = default(System.DateTime?), TaskExecutionResult? result = default(TaskExecutionResult?))
        {
            StartTime = startTime;
            EndTime = endTime;
            State = state;
            TaskRootDirectory = taskRootDirectory;
            TaskRootDirectoryUrl = taskRootDirectoryUrl;
            ExitCode = exitCode;
            ContainerInfo = containerInfo;
            FailureInfo = failureInfo;
            RetryCount = retryCount;
            LastRetryTime = lastRetryTime;
            Result = result;
            CustomInit();
        }

        /// <summary>
        /// An initialization method that performs custom operations like setting defaults
        /// </summary>
        partial void CustomInit();

        /// <summary>
        /// Gets or sets the time at which the Task started running.
        /// </summary>
        /// <remarks>
        /// If the Task has been restarted or retried, this is the most recent
        /// time at which the Task started running.
        /// </remarks>
        [JsonProperty(PropertyName = "startTime")]
        public System.DateTime StartTime { get; set; }

        /// <summary>
        /// Gets or sets the time at which the Job Preparation Task completed.
        /// </summary>
        /// <remarks>
        /// This property is set only if the Task is in the Completed state.
        /// </remarks>
        [JsonProperty(PropertyName = "endTime")]
        public System.DateTime? EndTime { get; set; }

        /// <summary>
        /// Gets or sets the current state of the Job Preparation Task on the
        /// Compute Node.
        /// </summary>
        /// <remarks>
        /// Possible values include: 'running', 'completed'
        /// </remarks>
        [JsonProperty(PropertyName = "state")]
        public JobPreparationTaskState State { get; set; }

        /// <summary>
        /// Gets or sets the root directory of the Job Preparation Task on the
        /// Compute Node. You can use this path to retrieve files created by
        /// the Task, such as log files.
        /// </summary>
        [JsonProperty(PropertyName = "taskRootDirectory")]
        public string TaskRootDirectory { get; set; }

        /// <summary>
        /// Gets or sets the URL to the root directory of the Job Preparation
        /// Task on the Compute Node.
        /// </summary>
        [JsonProperty(PropertyName = "taskRootDirectoryUrl")]
        public string TaskRootDirectoryUrl { get; set; }

        /// <summary>
        /// Gets or sets the exit code of the program specified on the Task
        /// command line.
        /// </summary>
        /// <remarks>
        /// This parameter is returned only if the Task is in the completed
        /// state. The exit code for a process reflects the specific convention
        /// implemented by the application developer for that process. If you
        /// use the exit code value to make decisions in your code, be sure
        /// that you know the exit code convention used by the application
        /// process. Note that the exit code may also be generated by the
        /// Compute Node operating system, such as when a process is forcibly
        /// terminated.
        /// </remarks>
        [JsonProperty(PropertyName = "exitCode")]
        public int? ExitCode { get; set; }

        /// <summary>
        /// Gets or sets information about the container under which the Task
        /// is executing.
        /// </summary>
        /// <remarks>
        /// This property is set only if the Task runs in a container context.
        /// </remarks>
        [JsonProperty(PropertyName = "containerInfo")]
        public TaskContainerExecutionInformation ContainerInfo { get; set; }

        /// <summary>
        /// Gets or sets information describing the Task failure, if any.
        /// </summary>
        /// <remarks>
        /// This property is set only if the Task is in the completed state and
        /// encountered a failure.
        /// </remarks>
        [JsonProperty(PropertyName = "failureInfo")]
        public TaskFailureInformation FailureInfo { get; set; }

        /// <summary>
        /// Gets or sets the number of times the Task has been retried by the
        /// Batch service. Task application failures (non-zero exit code) are
        /// retried, pre-processing errors (the Task could not be run) and file
        /// upload errors are not retried. The Batch service will retry the
        /// Task up to the limit specified by the constraints.
        /// </summary>
        /// <remarks>
        /// Task application failures (non-zero exit code) are retried,
        /// pre-processing errors (the Task could not be run) and file upload
        /// errors are not retried. The Batch service will retry the Task up to
        /// the limit specified by the constraints.
        /// </remarks>
        [JsonProperty(PropertyName = "retryCount")]
        public int RetryCount { get; set; }

        /// <summary>
        /// Gets or sets the most recent time at which a retry of the Job
        /// Preparation Task started running.
        /// </summary>
        /// <remarks>
        /// This property is set only if the Task was retried (i.e. retryCount
        /// is nonzero). If present, this is typically the same as startTime,
        /// but may be different if the Task has been restarted for reasons
        /// other than retry; for example, if the Compute Node was rebooted
        /// during a retry, then the startTime is updated but the lastRetryTime
        /// is not.
        /// </remarks>
        [JsonProperty(PropertyName = "lastRetryTime")]
        public System.DateTime? LastRetryTime { get; set; }

        /// <summary>
        /// Gets or sets the result of the Task execution.
        /// </summary>
        /// <remarks>
        /// If the value is 'failed', then the details of the failure can be
        /// found in the failureInfo property. Possible values include:
        /// 'success', 'failure'
        /// </remarks>
        [JsonProperty(PropertyName = "result")]
        public TaskExecutionResult? Result { get; set; }

    }
}