balena-sdk/es2018/models/image.d.ts

The Balena JavaScript SDK

import type { Image, InjectedDependenciesParam } from '..';
import type { ODataOptionsWithoutCount } from 'pinejs-client-core';
declare const getImageModel: (deps: InjectedDependenciesParam) => {
    /**
     * @summary Get a specific image
     * @name get
     * @public
     * @function
     * @memberof balena.models.image
     *
     * @param {Number} id - image id
     * @param {Object} [options={}] - extra pine options to use
     * @fulfil {Object} - image
     * @returns {Promise}
     *
     * @example
     * balena.models.image.get(123).then(function(image) {
     * 	console.log(image);
     * });
     */
    get<T extends ODataOptionsWithoutCount<Image["Read"]>>(id: number, options?: T): Promise<NonNullable<import("pinejs-client-core").OptionsToResponse<{
        created_at: import("@balena/sbvr-types").Types["Date Time"]["Read"];
        id: import("@balena/sbvr-types").Types["Integer"]["Read"];
        start_timestamp: import("@balena/sbvr-types").Types["Date Time"]["Read"];
        end_timestamp: import("@balena/sbvr-types").Types["Date Time"]["Read"] | null;
        dockerfile: import("@balena/sbvr-types").Types["Text"]["Read"] | null;
        is_a_build_of__service: {
            __id: import("..").Service["Read"]["id"];
        } | [import("..").Service["Read"]];
        image_size: import("@balena/sbvr-types").Types["Big Integer"]["Read"] | null;
        is_stored_at__image_location: import("@balena/sbvr-types").Types["Short Text"]["Read"];
        project_type: import("@balena/sbvr-types").Types["Short Text"]["Read"] | null;
        error_message: import("@balena/sbvr-types").Types["Text"]["Read"] | null;
        build_log: import("@balena/sbvr-types").Types["Text"]["Read"] | null;
        push_timestamp: import("@balena/sbvr-types").Types["Date Time"]["Read"] | null;
        status: import("@balena/sbvr-types").Types["Short Text"]["Read"];
        content_hash: import("@balena/sbvr-types").Types["Short Text"]["Read"] | null;
        contract: import("@balena/sbvr-types").Types["JSON"]["Read"] | null;
        device__installs__image?: Array<import("..").ImageInstall["Read"]>;
        image_install?: Array<import("..").ImageInstall["Read"]>;
        is_part_of__release?: Array<import("..").ImageIsPartOfRelease["Read"]>;
        image__is_part_of__release?: Array<import("..").ImageIsPartOfRelease["Read"]>;
        release_image?: Array<import("..").ImageIsPartOfRelease["Read"]>;
        is_a_build_of__application__has__service_name: {
            __id: import("..").Service["Read"]["id"];
        } | [import("..").Service["Read"]];
        is__origin__of__delta?: Array<import("..").Delta["Read"]>;
        is_produced_by__delta?: Array<import("..").Delta["Read"]>;
    }, T & {}, number>>>;
    /**
     * @summary Get the logs for an image
     * @name getLogs
     * @public
     * @function
     * @memberof balena.models.image
     *
     * @param {Number} id - image id
     * @fulfil {string | null} - logs
     * @returns {Promise}
     *
     * @example
     * balena.models.image.getLogs(123).then(function(logs) {
     * 	console.log(logs);
     * });
     */
    getLogs: (id: number) => Promise<string | null>;
};
export default getImageModel;