@broadcom/sysview-for-zowe-cli/lib/cli/CommandDefinitionOptions.d.ts

Zowe CLI plugin for SYSVIEW

import { ICommandOptionDefinition, ICommandPositionalDefinition } from "@zowe/imperative";
/**
 * Here are all the options used in SYSVIEW REST API commands.
 *
 * @export
 * @class CommandDefinitionOptions
 */
export declare class CommandDefinitionOptions {
    /**
     * Capture data set name from which to retrieve captured commands
     *
     * @static
     * @type {ICommandPositionalDefinition}
     * @memberof CommandDefinitionOptions
     */
    static CAPTURE_DSN_POSITIONAL: ICommandPositionalDefinition;
    /**
     * Captured command to retrieve
     *
     * @static
     * @type {ICommandPositionalDefinition}
     * @memberof CommandDefinitionOptions
     */
    static CAPTURE_COMMAND_POSITIONAL: ICommandPositionalDefinition;
    /**
     * Local file containing the Capture commands to be executed
     *
     * @static
     * @type {ICommandPositionalDefinition}
     * @memberof CommandDefinitionOptions
     */
    static CAPTURE_FILE_POSITIONAL: ICommandPositionalDefinition;
    /**
     * Command(s) to be issued
     *
     * @static
     * @type {ICommandPositionalDefinition}
     * @memberof CommandDefinitionOptions
     */
    static COMMAND_STRING_POSITIONAL: ICommandPositionalDefinition;
    /**
     * Row number of command within capture data set
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static CAPTURE_ROW_OPTION: ICommandOptionDefinition;
    /**
     * Screen name, for commands which have multiple screens
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static CAPTURE_SCREEN_OPTION: ICommandOptionDefinition;
    /**
     * The captured command screen title or a user supplied title specified on the CAPIMMED command
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static CAPTURE_TITLE_OPTION: ICommandOptionDefinition;
    /**
     * Capture description
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static CAPTURE_DESCRIPTION_OPTION: ICommandOptionDefinition;
    /**
     * Fields to be returned (by name). For example: "jobname" "cpu"
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static FIELDS_OPTION: ICommandOptionDefinition;
    /**
     * Return all rows of data, no matter how many. Overrides --row-start and --row-end.
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static ALL_ROWS_OPTION: ICommandOptionDefinition;
    /**
     * The first row of the response data to display
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static ROW_START_OPTION: ICommandOptionDefinition;
    /**
     * The last row of the response data to display
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static ROW_END_OPTION: ICommandOptionDefinition;
    /**
     * The number of seconds to wait before timing out
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static TIMEOUT_OPTION: ICommandOptionDefinition;
    /**
     * Don't accept types as parameter. Instead, use one of the following:
     * --overview for OVERVIEW;
     * --info for INFOALL;
     * --pretty for DATAFLDS;STATUS;
     * CONTEXT;DATAROWS; are always included
     */
    /**
     * Context fields to display. Defaults to hiding all context
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static CONTEXT_FIELDS_OPTION: ICommandOptionDefinition;
    /**
     * Display the overview section
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static OVERVIEW_OPTION: ICommandOptionDefinition;
    /**
     * Display the information area, if any
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static INFO_OPTION: ICommandOptionDefinition;
    /**
     * Display formatted data
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static PRETTY_OPTION: ICommandOptionDefinition;
    /**
     * Show a blank space instead of '0' values
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static BLANK_IF_ZERO_OPTION: ICommandOptionDefinition;
    /**
     * Format data as a set of Comma Seperated Values
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static RESPONSE_FORMAT_CSV_OPTION: ICommandOptionDefinition;
    /**
     * Truncate displays that are too wide for the console
     *
     * @static
     * @type {ICommandOptionDefinition}
     * @memberof CommandDefinitionOptions
     */
    static TRUNCATE_OPTION: ICommandOptionDefinition;
}