node-ovh-ts/dist/handlers/CaasContainers.d.ts

OVH API wrapper library for TypeScript

import { DockerStackCustomSslMessage } from '../models/DockerStackCustomSslMessage.js';
import { DockerFrameworkPassword } from '../models/DockerFrameworkPassword.js';
import { DockerStackInputCustomSsl } from '../models/DockerStackInputCustomSsl.js';
import { DockerStack } from '../models/DockerStack.js';
import { DockerSlave } from '../models/DockerSlave.js';
import { ServicesService } from '../models/ServicesService.js';
import { StackFrameworkApplication } from '../models/StackFrameworkApplication.js';
import { DockerStackCustomSsl } from '../models/DockerStackCustomSsl.js';
import { DockerStackRegistryCredentials } from '../models/DockerStackRegistryCredentials.js';
import { StackFramework } from '../models/StackFramework.js';
import { DockerSlaveFlavor } from '../models/DockerSlaveFlavor.js';
import OVHBase from '../ovh.js';
import '../models/DockerSlaveMetrics.js';
import '../models/DockerSlaveMetricsResources.js';
import '../models/DockerSlaveMetricsUsedResources.js';
import '../models/DockerSlaveStatus.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../models/DockerSlaveFrameworkApp.js';
import '../models/DockerSlaveFrameworkAppVolume.js';
import '../models/DockerSlaveFrameworkAppPort.js';
import '../models/DockerSlaveFrameworkAppEnvironment.js';
import '../endpoints.js';

declare class CaasContainersHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    listContainers: () => Promise<string[]>;
    /** List the /cloud flavors available for the Docker PaaS slaves */
    listContainersSlavesFlavors: () => Promise<string[]>;
    /** Inspect the argument slave flavor */
    getContainersSlavesFlavorsByFlavorId: (flavorId: string) => Promise<DockerSlaveFlavor>;
    /** Inspect the argument stack */
    getContainersByServiceName: (serviceName: string) => Promise<DockerStack>;
    /** List all the installable Mesos frameworks */
    listContainersAvailableFrameworksByServiceName: (serviceName: string) => Promise<string[]>;
    /** Launch a contact change procedure */
    launchContainersChangeContactByServiceName: (serviceName: string, body: {
        contactAdmin?: string;
        contactBilling?: string;
        contactTech?: string;
    }) => Promise<number[]>;
    /** List the frameworks installed on the argument stack */
    listContainersFrameworksByServiceName: (serviceName: string) => Promise<string[]>;
    /** Inspect the stack framework */
    getContainersFrameworksByServiceNameAndFrameworkId: (frameworkId: string, serviceName: string) => Promise<StackFramework>;
    /** List apps in the framework */
    listContainersFrameworksAppsByServiceNameAndFrameworkId: (frameworkId: string, serviceName: string) => Promise<StackFrameworkApplication>;
    /** Update the framework access password */
    updateContainersFrameworksPasswordByServiceNameAndFrameworkId: (frameworkId: string, serviceName: string, body: DockerFrameworkPassword) => Promise<void>;
    /** List the registry credentials associated to the stack. */
    listContainersRegistryCredentialsByServiceName: (serviceName: string) => Promise<string[]>;
    /** Associate the stack with some credentials to an authenticated registry. */
    postContainersRegistryCredentialsByServiceName: (serviceName: string, body: DockerStackInputCustomSsl) => Promise<DockerStackRegistryCredentials>;
    /** Delete the registry credentials. */
    deleteContainersRegistryCredentialsByServiceNameAndCredentialsId: (credentialsId: string, serviceName: string) => Promise<void>;
    /** Inspect the image registry credentials associated to the stack */
    getContainersRegistryCredentialsByServiceNameAndCredentialsId: (credentialsId: string, serviceName: string) => Promise<DockerStackRegistryCredentials>;
    /** Update the registry credentials. */
    updateContainersRegistryCredentialsByServiceNameAndCredentialsId: (credentialsId: string, serviceName: string, body: DockerStackInputCustomSsl) => Promise<DockerStackRegistryCredentials>;
    /** Get this object properties */
    getContainersServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateContainersServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** List the id of the registered slave instances */
    listContainersSlavesByServiceName: (serviceName: string) => Promise<string[]>;
    /** Inspect the argument user slave instance */
    getContainersSlavesByServiceNameAndSlaveId: (serviceName: string, slaveId: string) => Promise<DockerSlave>;
    /** Delete the custom SSL certificate and private key associated to the stack */
    deleteContainersSslByServiceName: (serviceName: string) => Promise<DockerStackCustomSslMessage>;
    /** Inspect the custom SSL certificate and private */
    getContainersSslByServiceName: (serviceName: string) => Promise<DockerStackCustomSsl>;
    /** Update the custom SSL certificate and private */
    updateContainersSslByServiceName: (serviceName: string, body: DockerStackInputCustomSsl) => Promise<DockerStackCustomSslMessage>;
}

export { CaasContainersHandler };