@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/options/SyncBackOptions.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

var EBGOptions = require('./EBGOptions.js');

/*
 * Copyright (c) 2019 Broadcom.  All Rights Reserved.  The term
 * "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 *
 * This software and all information contained therein is
 * confidential and proprietary and shall not be duplicated,
 * used, disclosed, or disseminated in any way except as
 * authorized by the applicable license agreement, without the
 * express written permission of Broadcom.  All authorized
 * reproductions must be marked with this language.
 *
 * EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
 * THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
 * SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
 * LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
 * FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT WILL BROADCOM
 * BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
 * DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
 * INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
 * INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
 * EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
 */
class SyncBackOptions extends EBGOptions.EBGOptions {
}
SyncBackOptions.MINUTES = "MINUTES";
SyncBackOptions.HOURS = "HOURS";
SyncBackOptions.DAYS = "DAYS";
SyncBackOptions.WEEKS = "WEEKS";
SyncBackOptions.MONTHS = "MONTHS";
SyncBackOptions.ENABLED = {
    name: "enabled",
    description: "Indicates if the sync-back option is enabled or disables one if set to false.",
    type: "boolean",
    defaultValue: true,
    required: false,
};
SyncBackOptions.OVERWRITE = {
    name: "overwrite",
    description: "Overwrites (true) or inherits (false) the global sync-back settings.",
    type: "boolean",
    defaultValue: true,
    required: false,
};
SyncBackOptions.START_DATE = {
    name: "startDate",
    description: "Indicates the start date of the sync-back schedule in UTC time zone. Format YYYY-MM-DD.",
    type: "string",
    required: false,
    implies: ["startTime"],
};
SyncBackOptions.START_TIME = {
    name: "startTime",
    description: "Indicates the start time of the sync-back schedule in UTC time zone. Format HH:MM:SS (24 hour format).",
    type: "string",
    required: false,
    implies: ["startDate"],
};
SyncBackOptions.INTERVAL = {
    name: "interval",
    description: "Specifies the number of time interval units for a scheduled sync-back run.",
    type: "number",
    defaultValue: 1,
    required: true,
};
SyncBackOptions.TIME_UNIT = {
    name: "timeUnit",
    description: "Specifies a time unit for the scheduled sync-back run interval.",
    type: "string",
    required: true,
    defaultValue: SyncBackOptions.HOURS,
    allowableValues: {
        values: [
            SyncBackOptions.MINUTES,
            SyncBackOptions.HOURS,
            SyncBackOptions.DAYS,
            SyncBackOptions.WEEKS,
            SyncBackOptions.MONTHS,
        ],
        caseSensitive: true,
    },
};

exports.SyncBackOptions = SyncBackOptions;