@serve.zone/api
Version:
The `@serve.zone/api` module is a robust and versatile API client, designed to facilitate seamless communication with various cloud resources managed by the Cloudly platform. This API client extends a rich set of functionalities, offering developers a com
29 lines (28 loc) • 1.2 kB
TypeScript
import type { CloudlyApiClient } from './classes.cloudlyapiclient.js';
import * as plugins from './plugins.js';
export declare class Image implements plugins.servezoneInterfaces.data.IImage {
static getImages(cloudlyClientRef: CloudlyApiClient): Promise<Image[]>;
static getImageById(cloudlyClientRef: CloudlyApiClient, imageIdArg: string): Promise<Image>;
/**
* creates a new image
*/
static createImage(cloudlyClientRef: CloudlyApiClient, imageDataArg: Partial<plugins.servezoneInterfaces.data.IImage['data']>): Promise<Image>;
cloudlyClientRef: CloudlyApiClient;
id: plugins.servezoneInterfaces.data.IImage['id'];
data: plugins.servezoneInterfaces.data.IImage['data'];
constructor(cloudlyClientRef: CloudlyApiClient);
/**
* updates the image data
*/
update(): Promise<void>;
/**
* pushes a new version of the image
* @param imageVersion
* @param imageReadableArg
*/
pushImageVersion(imageVersion: string, imageReadableArg: ReadableStream<Uint8Array>): Promise<void>;
/**
* pulls a version of the image
*/
pullImageVersion(versionStringArg: string): Promise<ReadableStream<Uint8Array>>;
}