@devopness/sdk-js/dist/api/generated/models/application-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.
 */
/**
 *
 * @export
 * @interface ApplicationUpdate
 */
export interface ApplicationUpdate {
    /**
     * The unique ID of the given Application.
     * @type {number}
     * @memberof ApplicationUpdate
     */
    id: number;
    /**
     * The application\'s unique name. Must not be greater than 60 characters.
     * @type {string}
     * @memberof ApplicationUpdate
     */
    name: string;
    /**
     * The optional command that should be executed once during deployment to build the source code and get the application in a ready state.
     * @type {string}
     * @memberof ApplicationUpdate
     */
    build_command?: string;
    /**
     * The language runtime engine version to be used to execute this application on the deployed servers. Must be at least 1 character. Must not be greater than 10 characters.
     * @type {string}
     * @memberof ApplicationUpdate
     */
    engine_version: string;
    /**
     * The base framework on top of which the application has been implemented - it might have impact on the steps to be performed during application deployment. Must not be greater than 30 characters.
     * @type {string}
     * @memberof ApplicationUpdate
     */
    framework: string;
    /**
     * The programming language runtime environment to be used to serve the application. E.g.: if a front-end web app is developed using Node.js, but should be served statically (a SPA application, for instance) then this field value should be `html`. Must not be greater than 30 characters.
     * @type {string}
     * @memberof ApplicationUpdate
     */
    programming_language: string;
    /**
     * The full name of a repository (`repository_owner/repository_name`) containing the application source code. Must not be greater than 100 characters.
     * @type {string}
     * @memberof ApplicationUpdate
     */
    repository?: string;
    /**
     * Numeric ID of the credential to source provider where the repository is hosted. This field is required when <code>repository</code> is present.
     * @type {number}
     * @memberof ApplicationUpdate
     */
    credential_id?: number;
    /**
     * The relative directory where package manager\'s manifest files (`package.json`, `composer.json`, `yarn.lock`, etc) are located. It needs to be set for applications where the actual source code is not located in the top level directory of the repository. Must start with one of <code>/</code>.
     * @type {string}
     * @memberof ApplicationUpdate
     */
    root_directory?: string;
    /**
     * The version control branch that, by default, will be used when a deployment is triggered and no other branch name is informed. Must not be greater than 200 characters.
     * @type {string}
     * @memberof ApplicationUpdate
     */
    default_branch: string;
    /**
     * The number of deployment history, logs and artifacts to keep stored in both devopness servers and user\'s servers. OR The number of deployment artifacts to be retained in the user\'s servers, making it easier and faster to rollback to previous versions. Must be at least 1. Must not be greater than 10.
     * @type {number}
     * @memberof ApplicationUpdate
     */
    deployments_keep?: number;
    /**
     * Indicates command that Devopness must execute to install application dependencies.
     * @type {string}
     * @memberof ApplicationUpdate
     */
    install_dependencies_command?: string;
}