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

OVH API wrapper library for TypeScript

import { ClusterHadoopNodeBillingProfile } from '../models/ClusterHadoopNodeBillingProfile.js';
import { ClusterHadoopRole } from '../models/ClusterHadoopRole.js';
import { ClusterHadoopOrderInformations } from '../models/ClusterHadoopOrderInformations.js';
import { ClusterHadoopClusterConsumption } from '../models/ClusterHadoopClusterConsumption.js';
import { ClusterHadoopNetworkAcl } from '../models/ClusterHadoopNetworkAcl.js';
import { ClusterHadoopNodeConsumption } from '../models/ClusterHadoopNodeConsumption.js';
import { ClusterHadoopRoleTypeEnum } from '../models/ClusterHadoopRoleTypeEnum.js';
import { ClusterHadoopClusterServiceNameEnum } from '../models/ClusterHadoopClusterServiceNameEnum.js';
import { ClusterHadoopUser } from '../models/ClusterHadoopUser.js';
import { ServicesService } from '../models/ServicesService.js';
import { ClusterHadoopNode } from '../models/ClusterHadoopNode.js';
import { ClusterHadoopTask } from '../models/ClusterHadoopTask.js';
import { ClusterHadoopHadoop } from '../models/ClusterHadoopHadoop.js';
import OVHBase from '../ovh.js';
import '../models/ClusterHadoopNetworkAclStateEnum.js';
import '../models/ClusterHadoopBillingNameEnum.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../models/ClusterHadoopNodeProfileEnum.js';
import '../models/ClusterHadoopNodeStateEnum.js';
import '../models/ClusterHadoopOperationStateEnum.js';
import '../models/ClusterHadoopClusterStateEnum.js';
import '../endpoints.js';

declare class ClusterHadoopHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    listHadoop: () => Promise<string[]>;
    /** Get informations about the order of one cluster */
    getHadoopOrderInformations: () => Promise<ClusterHadoopOrderInformations>;
    /** Get the orderable node profiles and their characteristics */
    getHadoopOrderableNodeProfiles: () => Promise<ClusterHadoopNodeBillingProfile[]>;
    /** Get this object properties */
    getHadoopByServiceName: (serviceName: string) => Promise<ClusterHadoopHadoop>;
    /** Get the current consumptions that you will billed for on the next bill */
    getHadoopConsumptionsByServiceName: (serviceName: string) => Promise<ClusterHadoopClusterConsumption>;
    /** Network ACL associated with this Hadoop Cluster */
    getHadoopNetworkAclByServiceName: (serviceName: string) => Promise<string[]>;
    /** Add an ACL to your cluster */
    addHadoopNetworkAclByServiceName: (serviceName: string, body: {
        block?: string;
        description?: string;
    }) => Promise<ClusterHadoopTask>;
    /** Remove this ACL */
    deleteHadoopNetworkAclByServiceNameAndBlock: (block: string, serviceName: string) => Promise<ClusterHadoopTask>;
    /** Get this object properties */
    getHadoopNetworkAclByServiceNameAndBlock: (block: string, serviceName: string) => Promise<ClusterHadoopNetworkAcl>;
    /** Alter this object properties */
    updateHadoopNetworkAclByServiceNameAndBlock: (block: string, serviceName: string, body: ClusterHadoopNetworkAcl) => Promise<void>;
    /** Nodes of the Cluster */
    getHadoopNodeByServiceName: (serviceName: string) => Promise<string[]>;
    /** Remove this Node from the Cluster */
    deleteHadoopNodeByServiceNameAndHostname: (hostname: string, serviceName: string) => Promise<ClusterHadoopTask>;
    /** Get this object properties */
    getHadoopNodeByServiceNameAndHostname: (hostname: string, serviceName: string) => Promise<ClusterHadoopNode>;
    /** Decommission the node and all the services on it */
    postHadoopNodeDecommissionByServiceNameAndHostname: (hostname: string, serviceName: string) => Promise<ClusterHadoopTask>;
    /** Recommission the node and all the services on it */
    postHadoopNodeRecommissionByServiceNameAndHostname: (hostname: string, serviceName: string) => Promise<ClusterHadoopTask>;
    /** Roles (ie set of Hadoop services) of the Node */
    getHadoopNodeRoleByServiceNameAndHostname: (hostname: string, serviceName: string) => Promise<ClusterHadoopRoleTypeEnum[]>;
    /** Add the Role to the Node */
    addHadoopNodeRoleByServiceNameAndHostname: (hostname: string, serviceName: string, body: {
        type: ClusterHadoopRoleTypeEnum;
    }) => Promise<ClusterHadoopTask>;
    /** Remove this Role from the Node */
    deleteHadoopNodeRoleByServiceNameAndHostnameAndType: (hostname: string, serviceName: string, type: ClusterHadoopRoleTypeEnum) => Promise<ClusterHadoopTask>;
    /** Get this object properties */
    getHadoopNodeRoleByServiceNameAndHostnameAndType: (hostname: string, serviceName: string, type: ClusterHadoopRoleTypeEnum) => Promise<ClusterHadoopRole>;
    /** Restart the role on the node (THIS ACTION WILL RESTART OTHER DEPENDANT ROLES) */
    postHadoopNodeRoleRestartByServiceNameAndHostnameAndType: (hostname: string, serviceName: string, type: ClusterHadoopRoleTypeEnum) => Promise<ClusterHadoopTask>;
    /** Start the role on the node */
    postHadoopNodeRoleStartByServiceNameAndHostnameAndType: (hostname: string, serviceName: string, type: ClusterHadoopRoleTypeEnum) => Promise<ClusterHadoopTask>;
    /** Stop the role on the node (THIS ACTION WILL STOP OTHER DEPENDANT ROLES) */
    postHadoopNodeRoleStopByServiceNameAndHostnameAndType: (hostname: string, serviceName: string, type: ClusterHadoopRoleTypeEnum) => Promise<ClusterHadoopTask>;
    /** Detailed description for each Node profile */
    getHadoopNodeBillingProfilesByServiceName: (serviceName: string) => Promise<ClusterHadoopNodeBillingProfile[]>;
    /** Get the current node consumptions that you will billed for on the next bill */
    getHadoopNodeConsumptionsByServiceName: (serviceName: string) => Promise<ClusterHadoopNodeConsumption[]>;
    /** Order a new node in the cluster */
    postHadoopOrderNewNodeHourlyByServiceName: (serviceName: string, body: {
        nodeProfile: string;
    }) => Promise<ClusterHadoopTask>;
    /** List of orderable Node profiles */
    listHadoopOrderableNodeProfilesByServiceName: (serviceName: string) => Promise<string[]>;
    /** Restart the Cloudera Manager Hadoop Cluster (THIS ACTION WILL RESTART EVERY SERVICE) */
    postHadoopRestartByServiceName: (serviceName: string) => Promise<ClusterHadoopTask>;
    /** Restart a Cloudera Manager service (THIS ACTION WILL RESTART OTHER DEPENDANT SERVICES) */
    postHadoopServiceRestartByServiceName: (serviceName: string, body: {
        service: ClusterHadoopClusterServiceNameEnum;
    }) => Promise<ClusterHadoopTask>;
    /** Start a Cloudera Manager service */
    postHadoopServiceStartByServiceName: (serviceName: string, body: {
        service: ClusterHadoopClusterServiceNameEnum;
    }) => Promise<ClusterHadoopTask>;
    /** Stop a Cloudera Manager service (THIS ACTION WILL STOP OTHER DEPENDANT SERVICES) */
    postHadoopServiceStopByServiceName: (serviceName: string, body: {
        service: ClusterHadoopClusterServiceNameEnum;
    }) => Promise<ClusterHadoopTask>;
    /** Get this object properties */
    getHadoopServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateHadoopServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** Start the Cloudera Manager Hadoop Cluster */
    postHadoopStartByServiceName: (serviceName: string) => Promise<ClusterHadoopTask>;
    /** Stop a Cloudera Manager Hadoop Cluster (THIS ACTION WILL STOP EVERY SERVICE) */
    postHadoopStopByServiceName: (serviceName: string) => Promise<ClusterHadoopTask>;
    /** Tasks associated with this Hadoop Cluster */
    getHadoopTaskByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get this object properties */
    getHadoopTaskByServiceNameAndTaskId: (serviceName: string, taskId: number) => Promise<ClusterHadoopTask>;
    /** Terminate your service. THE CLUSTER WILL BE DELETED. ALL YOUR DATA WILL BE LOST */
    postHadoopTerminateByServiceName: (serviceName: string) => Promise<ClusterHadoopTask>;
    /** Users associated with this Hadoop Cluster */
    getHadoopUserByServiceName: (serviceName: string) => Promise<string[]>;
    /** Add an User to your cluster */
    addHadoopUserByServiceName: (serviceName: string, body: {
        clouderaManager: boolean;
        httpFrontend: boolean;
        hue: boolean;
        password: string;
        username: string;
    }) => Promise<ClusterHadoopTask>;
    /** Remove this User */
    deleteHadoopUserByServiceNameAndUsername: (serviceName: string, username: string) => Promise<ClusterHadoopTask>;
    /** Get this object properties */
    getHadoopUserByServiceNameAndUsername: (serviceName: string, username: string) => Promise<ClusterHadoopUser>;
    /** Alter this object properties */
    updateHadoopUserByServiceNameAndUsername: (serviceName: string, username: string, body: ClusterHadoopUser) => Promise<void>;
    /** Reset the password for a given Hadoop Cluster User */
    postHadoopUserResetPasswordByServiceNameAndUsername: (serviceName: string, username: string, body: {
        password: string;
    }) => Promise<ClusterHadoopTask>;
}

export { ClusterHadoopHandler };