@devopness/sdk-js/dist/api/generated/models/application.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 { ApplicationLastDeployments } from './application-last-deployments';
import { CredentialRelation } from './credential-relation';
import { DaemonRelation } from './daemon-relation';
import { EnvironmentRelation } from './environment-relation';
import { ServerRelation } from './server-relation';
import { UserRelation } from './user-relation';
import { VirtualHostRelation } from './virtual-host-relation';
/**
 *
 * @export
 * @interface Application
 */
export interface Application {
    /**
     * Unique ID of the application
     * @type {number}
     * @memberof Application
     */
    id: number;
    /**
     * Numeric ID of the project to which the application belongs to
     * @type {number}
     * @memberof Application
     */
    project_id: number;
    /**
     * Numeric ID of the environment to which the application belongs to
     * @type {number}
     * @memberof Application
     */
    environment_id: number;
    /**
     * The id of the user who created the application and to whom the application belongs
     * @type {number}
     * @memberof Application
     */
    created_by: number;
    /**
     * The application\'s unique name
     * @type {string}
     * @memberof Application
     */
    name: string;
    /**
     * The full name of a repository (`repository_owner/repository_name`) containing the application source code.
     * @type {string}
     * @memberof Application
     */
    repository: string;
    /**
     * The name part of a repository full name (`repository_owner/repository_name`)
     * @type {string}
     * @memberof Application
     */
    repository_name: string;
    /**
     * The owner part of a repository full name (`repository_owner/repository_name`)
     * @type {string}
     * @memberof Application
     */
    repository_owner: string;
    /**
     * The version control branch that, by default, will be used when a deployment is triggered and no other branch name is informed.
     * @type {string}
     * @memberof Application
     */
    default_branch: 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`.
     * @type {string}
     * @memberof Application
     */
    programming_language: string;
    /**
     * The human readable version of the programming language of the application.
     * @type {string}
     * @memberof Application
     */
    programming_language_human_readable: string;
    /**
     * The language runtime engine version to be used to execute this application on the deployed servers
     * @type {string}
     * @memberof Application
     */
    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
     * @type {string}
     * @memberof Application
     */
    framework: string;
    /**
     * The human readable version of the framework of the application.
     * @type {string}
     * @memberof Application
     */
    framework_human_readable: string;
    /**
     * 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.
     * @type {string}
     * @memberof Application
     */
    root_directory: 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
     * @type {number}
     * @memberof Application
     */
    deployments_keep: number;
    /**
     * Indicates command that Devopness must execute to install application dependencies
     * @type {string}
     * @memberof Application
     */
    install_dependencies_command: string | null;
    /**
     * 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 Application
     */
    build_command: string | null;
    /**
     *
     * @type {UserRelation}
     * @memberof Application
     */
    created_by_user: UserRelation;
    /**
     *
     * @type {ApplicationLastDeployments}
     * @memberof Application
     */
    last_deployments: ApplicationLastDeployments;
    /**
     *
     * @type {EnvironmentRelation}
     * @memberof Application
     */
    environment: EnvironmentRelation | null;
    /**
     *
     * @type {Array<ServerRelation>}
     * @memberof Application
     */
    servers: Array<ServerRelation>;
    /**
     *
     * @type {CredentialRelation}
     * @memberof Application
     */
    credential: CredentialRelation | null;
    /**
     *
     * @type {Array<VirtualHostRelation>}
     * @memberof Application
     */
    virtual_hosts: Array<VirtualHostRelation>;
    /**
     *
     * @type {Array<DaemonRelation>}
     * @memberof Application
     */
    daemons: Array<DaemonRelation>;
    /**
     * The date and time when the record was created
     * @type {string}
     * @memberof Application
     */
    created_at: string;
    /**
     * The date and time when the record was last updated
     * @type {string}
     * @memberof Application
     */
    updated_at: string;
}