@devopness/sdk-js/dist/api/generated/models/service.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 { ActionRelation } from './action-relation';
import { EnvironmentRelation } from './environment-relation';
import { ProjectRelation } from './project-relation';
import { ServerRelation } from './server-relation';
import { ServiceInitialState } from './service-initial-state';
import { UserRelation } from './user-relation';
/**
 *
 * @export
 * @interface Service
 */
export interface Service {
    /**
     * The unique ID of the given service
     * @type {number}
     * @memberof Service
     */
    id: number;
    /**
     * The human readable service name
     * @type {string}
     * @memberof Service
     */
    name: string;
    /**
     * The service type
     * @type {string}
     * @memberof Service
     */
    type: string;
    /**
     * Formatted/human readable version of the service type
     * @type {string}
     * @memberof Service
     */
    type_human_readable: string;
    /**
     * The service current installed version
     * @type {string}
     * @memberof Service
     */
    version: string | null;
    /**
     * Indicates if the service was auto_generated by `Devopness` itself
     * @type {boolean}
     * @memberof Service
     */
    is_auto_generated: boolean;
    /**
     * Indicates if the service will start automatically on operating system boot
     * @type {boolean}
     * @memberof Service
     */
    auto_start: boolean;
    /**
     *
     * @type {ServiceInitialState}
     * @memberof Service
     */
    initial_state: ServiceInitialState;
    /**
     * A text describing the service, provided by the service author
     * @type {string}
     * @memberof Service
     */
    description: string | null;
    /**
     *
     * @type {EnvironmentRelation}
     * @memberof Service
     */
    environment: EnvironmentRelation | null;
    /**
     *
     * @type {UserRelation}
     * @memberof Service
     */
    created_by_user: UserRelation;
    /**
     *
     * @type {ProjectRelation}
     * @memberof Service
     */
    project: ProjectRelation | null;
    /**
     *
     * @type {Array<ServerRelation>}
     * @memberof Service
     */
    servers: Array<ServerRelation>;
    /**
     *
     * @type {ActionRelation}
     * @memberof Service
     */
    last_action: ActionRelation | null;
    /**
     * The date and time when the record was created
     * @type {string}
     * @memberof Service
     */
    created_at: string;
    /**
     * The date and time when the record was last updated
     * @type {string}
     * @memberof Service
     */
    updated_at: string;
}