JobScheduleState.cs

// 
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

// 

namespace Microsoft.Azure.Batch.Common
{
    using System;
    using System.Linq;
    
    /// <summary>
    /// The state of a job schedule.
    /// </summary>
    public enum JobScheduleState
    {
        /// <summary>
        /// The job schedule is active and will create jobs as per its schedule.
        /// </summary>
        Active,
        
        /// <summary>
        /// The schedule has terminated, either by reaching its end time or by
        /// the user terminating it explicitly.
        /// </summary>
        Completed,
        
        /// <summary>
        /// The user has disabled the schedule. The scheduler will not initiate
        /// any new jobs will on this schedule, but any existing active job
        /// will continue to run.
        /// </summary>
        Disabled,
        
        /// <summary>
        /// The schedule has no more work to do, or has been explicitly
        /// terminated by the user, but the termination operation is still in
        /// progress. The scheduler will not initiate any new jobs for this
        /// schedule, nor is any existing job active.
        /// </summary>
        Terminating,
        
        /// <summary>
        /// The user has requested that the schedule be deleted, but the delete
        /// operation is still in progress. The scheduler will not initiate
        /// any new jobs for this schedule, but any existing active job will
        /// continue to run. The schedule will be deleted when the existing
        /// job completes.
        /// </summary>
        Deleting,
    }
}