generated/api/Models/PlanSnapshotOptions.cs

// Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.10.2, generator: @autorest/powershell@4.0.708)
// Changes may cause incorrect behavior and will be lost if the code is regenerated.

namespace Commvault.Powershell.Models
{
    using static Commvault.Powershell.Runtime.Extensions;

    /// <summary>This feature applies only to File System Agents</summary>
    public partial class PlanSnapshotOptions :
        Commvault.Powershell.Models.IPlanSnapshotOptions,
        Commvault.Powershell.Models.IPlanSnapshotOptionsInternal
    {

        /// <summary>Backing field for <see cref="BackupCopyFrequency" /> property.</summary>
        private Commvault.Powershell.Models.IBackupFrequencyPattern _backupCopyFrequency;

        /// <summary>Used to describe the frequency of backup</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Owned)]
        internal Commvault.Powershell.Models.IBackupFrequencyPattern BackupCopyFrequency { get => (this._backupCopyFrequency = this._backupCopyFrequency ?? new Commvault.Powershell.Models.BackupFrequencyPattern()); set => this._backupCopyFrequency = value; }

        /// <summary>Day on which to run the schedule, applicable for monthly, yearly</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public long? BackupCopyFrequencyDayOfMonth { get => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).DayOfMonth; set => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).DayOfMonth = value ?? default(long); }

        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public string BackupCopyFrequencyDayOfWeek { get => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).DayOfWeek; set => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).DayOfWeek = value ?? null; }

        /// <summary>
        /// Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes,
        /// for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months
        /// </summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public long? BackupCopyFrequencyFrequency { get => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).Frequency; set => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).Frequency = value ?? default(long); }

        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public string BackupCopyFrequencyMonthOfYear { get => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).MonthOfYear; set => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).MonthOfYear = value ?? null; }

        /// <summary>schedule frequency type</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public string BackupCopyFrequencyScheduleFrequencyType { get => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).ScheduleFrequencyType; set => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).ScheduleFrequencyType = value ?? null; }

        /// <summary>start time of schedule in seconds for daily, weekly, monthly, yearly frequency</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public long? BackupCopyFrequencyStartTime { get => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).StartTime; set => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).StartTime = value ?? default(long); }

        /// <summary>Specific week of a month</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public string BackupCopyFrequencyWeekOfMonth { get => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).WeekOfMonth; set => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).WeekOfMonth = value ?? null; }

        /// <summary>Days of the week for weekly frequency</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public System.Collections.Generic.List<string> BackupCopyFrequencyWeeklyDays { get => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).WeeklyDays; set => ((Commvault.Powershell.Models.IBackupFrequencyPatternInternal)BackupCopyFrequency).WeeklyDays = value ?? null /* arrayOf */; }

        /// <summary>Which type of action should be followed if backup copy falls behind</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public string BackupCopyOptionAction { get => ((Commvault.Powershell.Models.IBackupCopyOptionsInternal)BackupCopyOptions).Action; set => ((Commvault.Powershell.Models.IBackupCopyOptionsInternal)BackupCopyOptions).Action = value ?? null; }

        /// <summary>Alert to throw when backup copy falls behind in hours</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public long? BackupCopyOptionAlertInHours { get => ((Commvault.Powershell.Models.IBackupCopyOptionsInternal)BackupCopyOptions).AlertInHours; set => ((Commvault.Powershell.Models.IBackupCopyOptionsInternal)BackupCopyOptions).AlertInHours = value ?? default(long); }

        /// <summary>
        /// Which type of backup type should be copied for the given backup destination when backup type is not all jobs. Default
        /// is LAST while adding new backup destination.
        /// </summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public string BackupCopyOptionBackupFullToCopy { get => ((Commvault.Powershell.Models.IBackupCopyOptionsInternal)BackupCopyOptions).BackupFullToCopy; set => ((Commvault.Powershell.Models.IBackupCopyOptionsInternal)BackupCopyOptions).BackupFullToCopy = value ?? null; }

        /// <summary>Backup type to copy for backup copy operation</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public string BackupCopyOptionBackupTypeToCopy { get => ((Commvault.Powershell.Models.IBackupCopyOptionsInternal)BackupCopyOptions).BackupTypeToCopy; set => ((Commvault.Powershell.Models.IBackupCopyOptionsInternal)BackupCopyOptions).BackupTypeToCopy = value ?? null; }

        /// <summary>Flag to enable backup copy fallen behind alert</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public bool? BackupCopyOptionEnableAlert { get => ((Commvault.Powershell.Models.IBackupCopyOptionsInternal)BackupCopyOptions).EnableAlert; set => ((Commvault.Powershell.Models.IBackupCopyOptionsInternal)BackupCopyOptions).EnableAlert = value ?? default(bool); }

        /// <summary>The allowable delay in days before a backup copy job is considered overdue</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public long? BackupCopyOptionSkipAfterThresholdDays { get => ((Commvault.Powershell.Models.IBackupCopyOptionsInternal)BackupCopyOptions).SkipAfterThresholdDays; set => ((Commvault.Powershell.Models.IBackupCopyOptionsInternal)BackupCopyOptions).SkipAfterThresholdDays = value ?? default(long); }

        /// <summary>
        /// Snapshots to be copied from a particular time in unix time format. By default, 0 means since the inception of the snap
        /// copy.
        /// </summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Inlined)]
        public long? BackupCopyOptionStartTime { get => ((Commvault.Powershell.Models.IBackupCopyOptionsInternal)BackupCopyOptions).StartTime; set => ((Commvault.Powershell.Models.IBackupCopyOptionsInternal)BackupCopyOptions).StartTime = value ?? default(long); }

        /// <summary>Backing field for <see cref="BackupCopyOptions" /> property.</summary>
        private Commvault.Powershell.Models.IBackupCopyOptions _backupCopyOptions;

        /// <summary>Options for snap management with backup copy</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Owned)]
        internal Commvault.Powershell.Models.IBackupCopyOptions BackupCopyOptions { get => (this._backupCopyOptions = this._backupCopyOptions ?? new Commvault.Powershell.Models.BackupCopyOptions()); set => this._backupCopyOptions = value; }

        /// <summary>Backing field for <see cref="BackupCopyRpoMins" /> property.</summary>
        private long? _backupCopyRpoMins;

        /// <summary>Backup copy RPO in minutes</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Owned)]
        public long? BackupCopyRpoMins { get => this._backupCopyRpoMins; set => this._backupCopyRpoMins = value; }

        /// <summary>Internal Acessors for BackupCopyFrequency</summary>
        Commvault.Powershell.Models.IBackupFrequencyPattern Commvault.Powershell.Models.IPlanSnapshotOptionsInternal.BackupCopyFrequency { get => (this._backupCopyFrequency = this._backupCopyFrequency ?? new Commvault.Powershell.Models.BackupFrequencyPattern()); set { {_backupCopyFrequency = value;} } }

        /// <summary>Internal Acessors for BackupCopyOptions</summary>
        Commvault.Powershell.Models.IBackupCopyOptions Commvault.Powershell.Models.IPlanSnapshotOptionsInternal.BackupCopyOptions { get => (this._backupCopyOptions = this._backupCopyOptions ?? new Commvault.Powershell.Models.BackupCopyOptions()); set { {_backupCopyOptions = value;} } }

        /// <summary>Backing field for <see cref="EnableBackupCopy" /> property.</summary>
        private bool? _enableBackupCopy;

        /// <summary>Flag to enable backup copy</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Owned)]
        public bool? EnableBackupCopy { get => this._enableBackupCopy; set => this._enableBackupCopy = value; }

        /// <summary>Backing field for <see cref="EnableSnapCatalog" /> property.</summary>
        private bool? _enableSnapCatalog;

        /// <summary>Flag to enable deferred snapshot cataloging</summary>
        [Commvault.Powershell.Origin(Commvault.Powershell.PropertyOrigin.Owned)]
        public bool? EnableSnapCatalog { get => this._enableSnapCatalog; set => this._enableSnapCatalog = value; }

        /// <summary>Creates an new <see cref="PlanSnapshotOptions" /> instance.</summary>
        public PlanSnapshotOptions()
        {

        }
    }
    /// This feature applies only to File System Agents
    public partial interface IPlanSnapshotOptions :
        Commvault.Powershell.Runtime.IJsonSerializable
    {
        /// <summary>Day on which to run the schedule, applicable for monthly, yearly</summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"Day on which to run the schedule, applicable for monthly, yearly",
        SerializedName = @"dayOfMonth",
        PossibleTypes = new [] { typeof(long) })]
        long? BackupCopyFrequencyDayOfMonth { get; set; }

        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"",
        SerializedName = @"dayOfWeek",
        PossibleTypes = new [] { typeof(string) })]
        string BackupCopyFrequencyDayOfWeek { get; set; }
        /// <summary>
        /// Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes,
        /// for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months
        /// </summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes, for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months",
        SerializedName = @"frequency",
        PossibleTypes = new [] { typeof(long) })]
        long? BackupCopyFrequencyFrequency { get; set; }

        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"",
        SerializedName = @"monthOfYear",
        PossibleTypes = new [] { typeof(string) })]
        string BackupCopyFrequencyMonthOfYear { get; set; }
        /// <summary>schedule frequency type</summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"schedule frequency type",
        SerializedName = @"scheduleFrequencyType",
        PossibleTypes = new [] { typeof(string) })]
        string BackupCopyFrequencyScheduleFrequencyType { get; set; }
        /// <summary>start time of schedule in seconds for daily, weekly, monthly, yearly frequency</summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"start time of schedule in seconds for daily, weekly, monthly, yearly frequency",
        SerializedName = @"startTime",
        PossibleTypes = new [] { typeof(long) })]
        long? BackupCopyFrequencyStartTime { get; set; }
        /// <summary>Specific week of a month</summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"Specific week of a month",
        SerializedName = @"weekOfMonth",
        PossibleTypes = new [] { typeof(string) })]
        string BackupCopyFrequencyWeekOfMonth { get; set; }
        /// <summary>Days of the week for weekly frequency</summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"Days of the week for weekly frequency",
        SerializedName = @"weeklyDays",
        PossibleTypes = new [] { typeof(string) })]
        System.Collections.Generic.List<string> BackupCopyFrequencyWeeklyDays { get; set; }
        /// <summary>Which type of action should be followed if backup copy falls behind</summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"Which type of action should be followed if backup copy falls behind",
        SerializedName = @"action",
        PossibleTypes = new [] { typeof(string) })]
        string BackupCopyOptionAction { get; set; }
        /// <summary>Alert to throw when backup copy falls behind in hours</summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"Alert to throw when backup copy falls behind in hours",
        SerializedName = @"alertInHours",
        PossibleTypes = new [] { typeof(long) })]
        long? BackupCopyOptionAlertInHours { get; set; }
        /// <summary>
        /// Which type of backup type should be copied for the given backup destination when backup type is not all jobs. Default
        /// is LAST while adding new backup destination.
        /// </summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"Which type of backup type should be copied for the given backup destination when backup type is not all jobs. Default is LAST while adding new backup destination.",
        SerializedName = @"backupFullToCopy",
        PossibleTypes = new [] { typeof(string) })]
        string BackupCopyOptionBackupFullToCopy { get; set; }
        /// <summary>Backup type to copy for backup copy operation</summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"Backup type to copy for backup copy operation",
        SerializedName = @"backupTypeToCopy",
        PossibleTypes = new [] { typeof(string) })]
        string BackupCopyOptionBackupTypeToCopy { get; set; }
        /// <summary>Flag to enable backup copy fallen behind alert</summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"Flag to enable backup copy fallen behind alert",
        SerializedName = @"enableAlert",
        PossibleTypes = new [] { typeof(bool) })]
        bool? BackupCopyOptionEnableAlert { get; set; }
        /// <summary>The allowable delay in days before a backup copy job is considered overdue</summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"The allowable delay in days before a backup copy job is considered overdue",
        SerializedName = @"skipAfterThresholdDays",
        PossibleTypes = new [] { typeof(long) })]
        long? BackupCopyOptionSkipAfterThresholdDays { get; set; }
        /// <summary>
        /// Snapshots to be copied from a particular time in unix time format. By default, 0 means since the inception of the snap
        /// copy.
        /// </summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"Snapshots to be copied from a particular time in unix time format. By default, 0 means since the inception of the snap copy.",
        SerializedName = @"startTime",
        PossibleTypes = new [] { typeof(long) })]
        long? BackupCopyOptionStartTime { get; set; }
        /// <summary>Backup copy RPO in minutes</summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"Backup copy RPO in minutes",
        SerializedName = @"backupCopyRPOMins",
        PossibleTypes = new [] { typeof(long) })]
        long? BackupCopyRpoMins { get; set; }
        /// <summary>Flag to enable backup copy</summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"Flag to enable backup copy",
        SerializedName = @"enableBackupCopy",
        PossibleTypes = new [] { typeof(bool) })]
        bool? EnableBackupCopy { get; set; }
        /// <summary>Flag to enable deferred snapshot cataloging</summary>
        [Commvault.Powershell.Runtime.Info(
        Required = false,
        ReadOnly = false,
        Read = true,
        Create = true,
        Update = true,
        Description = @"Flag to enable deferred snapshot cataloging",
        SerializedName = @"enableSnapCatalog",
        PossibleTypes = new [] { typeof(bool) })]
        bool? EnableSnapCatalog { get; set; }

    }
    /// This feature applies only to File System Agents
    internal partial interface IPlanSnapshotOptionsInternal

    {
        /// <summary>Used to describe the frequency of backup</summary>
        Commvault.Powershell.Models.IBackupFrequencyPattern BackupCopyFrequency { get; set; }
        /// <summary>Day on which to run the schedule, applicable for monthly, yearly</summary>
        long? BackupCopyFrequencyDayOfMonth { get; set; }

        string BackupCopyFrequencyDayOfWeek { get; set; }
        /// <summary>
        /// Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes,
        /// for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months
        /// </summary>
        long? BackupCopyFrequencyFrequency { get; set; }

        string BackupCopyFrequencyMonthOfYear { get; set; }
        /// <summary>schedule frequency type</summary>
        string BackupCopyFrequencyScheduleFrequencyType { get; set; }
        /// <summary>start time of schedule in seconds for daily, weekly, monthly, yearly frequency</summary>
        long? BackupCopyFrequencyStartTime { get; set; }
        /// <summary>Specific week of a month</summary>
        string BackupCopyFrequencyWeekOfMonth { get; set; }
        /// <summary>Days of the week for weekly frequency</summary>
        System.Collections.Generic.List<string> BackupCopyFrequencyWeeklyDays { get; set; }
        /// <summary>Which type of action should be followed if backup copy falls behind</summary>
        string BackupCopyOptionAction { get; set; }
        /// <summary>Alert to throw when backup copy falls behind in hours</summary>
        long? BackupCopyOptionAlertInHours { get; set; }
        /// <summary>
        /// Which type of backup type should be copied for the given backup destination when backup type is not all jobs. Default
        /// is LAST while adding new backup destination.
        /// </summary>
        string BackupCopyOptionBackupFullToCopy { get; set; }
        /// <summary>Backup type to copy for backup copy operation</summary>
        string BackupCopyOptionBackupTypeToCopy { get; set; }
        /// <summary>Flag to enable backup copy fallen behind alert</summary>
        bool? BackupCopyOptionEnableAlert { get; set; }
        /// <summary>The allowable delay in days before a backup copy job is considered overdue</summary>
        long? BackupCopyOptionSkipAfterThresholdDays { get; set; }
        /// <summary>
        /// Snapshots to be copied from a particular time in unix time format. By default, 0 means since the inception of the snap
        /// copy.
        /// </summary>
        long? BackupCopyOptionStartTime { get; set; }
        /// <summary>Options for snap management with backup copy</summary>
        Commvault.Powershell.Models.IBackupCopyOptions BackupCopyOptions { get; set; }
        /// <summary>Backup copy RPO in minutes</summary>
        long? BackupCopyRpoMins { get; set; }
        /// <summary>Flag to enable backup copy</summary>
        bool? EnableBackupCopy { get; set; }
        /// <summary>Flag to enable deferred snapshot cataloging</summary>
        bool? EnableSnapCatalog { get; set; }

    }
}