< Summary

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

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
.ctor()-100%100%
.ctor(...)-100%100%
get_AutoPoolIdPrefix()-100%100%
get_PoolLifetimeOption()-100%100%
get_KeepAlive()-100%100%
get_Pool()-100%100%

File(s)

C:\Git\azure-sdk-for-net\sdk\batch\Microsoft.Azure.Batch\src\GeneratedProtocol\Models\AutoPoolSpecification.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    /// Specifies characteristics for a temporary 'auto pool'. The Batch
 18    /// service will create this auto Pool when the Job is submitted.
 19    /// </summary>
 20    public partial class AutoPoolSpecification
 21    {
 22        /// <summary>
 23        /// Initializes a new instance of the AutoPoolSpecification class.
 24        /// </summary>
 60025        public AutoPoolSpecification()
 26        {
 27            CustomInit();
 60028        }
 29
 30        /// <summary>
 31        /// Initializes a new instance of the AutoPoolSpecification class.
 32        /// </summary>
 33        /// <param name="poolLifetimeOption">The minimum lifetime of created
 34        /// auto Pools, and how multiple Jobs on a schedule are assigned to
 35        /// Pools.</param>
 36        /// <param name="autoPoolIdPrefix">A prefix to be added to the unique
 37        /// identifier when a Pool is automatically created.</param>
 38        /// <param name="keepAlive">Whether to keep an auto Pool alive after
 39        /// its lifetime expires.</param>
 40        /// <param name="pool">The Pool specification for the auto
 41        /// Pool.</param>
 242        public AutoPoolSpecification(PoolLifetimeOption poolLifetimeOption, string autoPoolIdPrefix = default(string), b
 43        {
 244            AutoPoolIdPrefix = autoPoolIdPrefix;
 245            PoolLifetimeOption = poolLifetimeOption;
 246            KeepAlive = keepAlive;
 247            Pool = pool;
 48            CustomInit();
 249        }
 50
 51        /// <summary>
 52        /// An initialization method that performs custom operations like setting defaults
 53        /// </summary>
 54        partial void CustomInit();
 55
 56        /// <summary>
 57        /// Gets or sets a prefix to be added to the unique identifier when a
 58        /// Pool is automatically created.
 59        /// </summary>
 60        /// <remarks>
 61        /// The Batch service assigns each auto Pool a unique identifier on
 62        /// creation. To distinguish between Pools created for different
 63        /// purposes, you can specify this element to add a prefix to the ID
 64        /// that is assigned. The prefix can be up to 20 characters long.
 65        /// </remarks>
 66        [JsonProperty(PropertyName = "autoPoolIdPrefix")]
 139767        public string AutoPoolIdPrefix { get; set; }
 68
 69        /// <summary>
 70        /// Gets or sets the minimum lifetime of created auto Pools, and how
 71        /// multiple Jobs on a schedule are assigned to Pools.
 72        /// </summary>
 73        /// <remarks>
 74        /// Possible values include: 'jobSchedule', 'job'
 75        /// </remarks>
 76        [JsonProperty(PropertyName = "poolLifetimeOption")]
 141277        public PoolLifetimeOption PoolLifetimeOption { get; set; }
 78
 79        /// <summary>
 80        /// Gets or sets whether to keep an auto Pool alive after its lifetime
 81        /// expires.
 82        /// </summary>
 83        /// <remarks>
 84        /// If false, the Batch service deletes the Pool once its lifetime (as
 85        /// determined by the poolLifetimeOption setting) expires; that is,
 86        /// when the Job or Job Schedule completes. If true, the Batch service
 87        /// does not delete the Pool automatically. It is up to the user to
 88        /// delete auto Pools created with this option.
 89        /// </remarks>
 90        [JsonProperty(PropertyName = "keepAlive")]
 140191        public bool? KeepAlive { get; set; }
 92
 93        /// <summary>
 94        /// Gets or sets the Pool specification for the auto Pool.
 95        /// </summary>
 96        [JsonProperty(PropertyName = "pool")]
 139997        public PoolSpecification Pool { get; set; }
 98
 99    }
 100}