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

OVH API wrapper library for TypeScript

import { AnalyticsClusterDestroy } from '../models/AnalyticsClusterDestroy.js';
import { AnalyticsClusterNode } from '../models/AnalyticsClusterNode.js';
import { ServiceTerminationReasonEnum } from '../models/ServiceTerminationReasonEnum.js';
import { AnalyticsClusterActivity } from '../models/AnalyticsClusterActivity.js';
import { ServicesService } from '../models/ServicesService.js';
import { AnalyticsClusterDeployStatus } from '../models/AnalyticsClusterDeployStatus.js';
import { ServiceTerminationFutureUseEnum } from '../models/ServiceTerminationFutureUseEnum.js';
import { AnalyticsCluster } from '../models/AnalyticsCluster.js';
import { AnalyticsPlatformCapability } from '../models/AnalyticsPlatformCapability.js';
import { AnalyticsClusterDeploy } from '../models/AnalyticsClusterDeploy.js';
import OVHBase from '../ovh.js';
import '../models/AnalyticsNodeTypeEnum.js';
import '../models/AnalyticsStatusEnum.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../models/AnalyticsNodeCapability.js';
import '../models/AnalyticsPlatformCapabilityRequirement.js';
import '../models/AnalyticsComponent.js';
import '../models/AnalyticsNodeDeploy.js';
import '../endpoints.js';

declare class AnalyticsHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** Platform capabilities */
    getCapabilitiesPlatforms: () => Promise<AnalyticsPlatformCapability[]>;
    /** List available services */
    listPlatforms: () => Promise<string[]>;
    /** Get details about a service */
    getPlatformsByServiceName: (serviceName: string) => Promise<AnalyticsCluster>;
    /** Get activity logs */
    getPlatformsActivityByServiceName: (serviceName: string) => Promise<AnalyticsClusterActivity[]>;
    /** Launch a contact change procedure */
    launchPlatformsChangeContactByServiceName: (serviceName: string, body: {
        contactAdmin?: string;
        contactBilling?: string;
        contactTech?: string;
    }) => Promise<number[]>;
    /** Confirm termination of your service */
    confirmPlatformsTerminationByServiceName: (serviceName: string, body: {
        commentary?: string;
        futureUse?: ServiceTerminationFutureUseEnum;
        reason?: ServiceTerminationReasonEnum;
        token: string;
    }) => Promise<string>;
    /** Deploy an Analytics Data Platform */
    postPlatformsDeployByServiceName: (serviceName: string, body: AnalyticsClusterDeploy) => Promise<AnalyticsClusterDeploy>;
    /** Destroy an Analytics Data Platform */
    postPlatformsDestroyByServiceName: (serviceName: string, body: AnalyticsClusterDestroy) => Promise<void>;
    /** List available nodes */
    listPlatformsNodesByServiceName: (serviceName: string) => Promise<string[]>;
    /** Get details about nodes */
    getPlatformsNodesByServiceNameAndNodeId: (nodeId: string, serviceName: string) => Promise<AnalyticsClusterNode>;
    /** Get this object properties */
    getPlatformsServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updatePlatformsServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** Get cluster deployment status */
    getPlatformsStatusByServiceName: (serviceName: string) => Promise<AnalyticsClusterDeployStatus[]>;
    /** Terminate your service */
    postPlatformsTerminateByServiceName: (serviceName: string) => Promise<string>;
}

export { AnalyticsHandler };