@devopness/sdk-js/dist/api/generated/models/variable-update.d.ts

Devopness API JS/TS SDK - Painless essential DevOps to everyone

/**
 * devopness API
 * Devopness API - Painless essential DevOps to everyone
 *
 * The version of the OpenAPI document: latest
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { VariableTarget } from './variable-target';
import { VariableType } from './variable-type';
/**
 *
 * @export
 * @interface VariableUpdate
 */
export interface VariableUpdate {
    /**
     * The unique ID of the given Variable.
     * @type {number}
     * @memberof VariableUpdate
     */
    id: number;
    /**
     * The unique key used to identify the variable on the target.                     When variable is of type `file`, this is the relative path                     to the file within the application directory. Must not be greater than 100 characters.
     * @type {string}
     * @memberof VariableUpdate
     */
    key: string;
    /**
     * The value to be assigned to this variable when deployed to its target.                     When variable is of type `file`, this is the file content. Must not be greater than 21504 characters.
     * @type {string}
     * @memberof VariableUpdate
     */
    value: string;
    /**
     * A text describing the variable, provided by the end user. Must not be greater than 255 characters.
     * @type {string}
     * @memberof VariableUpdate
     */
    description?: string;
    /**
     *
     * @type {VariableTarget}
     * @memberof VariableUpdate
     */
    target: VariableTarget;
    /**
     *
     * @type {VariableType}
     * @memberof VariableUpdate
     */
    type: VariableType;
    /**
     * Indicates if the variable value should be visible or not in the deployment logs.
     * @type {boolean}
     * @memberof VariableUpdate
     */
    hidden: boolean;
}