@hashgraph/solo
    Preparing search index...

    Interface OneShotCommand

    interface OneShotCommand {
        chartManager?: ChartManager;
        componentFactory?: ComponentFactoryApi;
        configManager?: ConfigManager;
        depManager?: DependencyManager;
        helm?: HelmClient;
        k8Factory?: K8Factory;
        leaseManager?: LockManager;
        localConfig?: LocalConfigRuntimeState;
        logger?: SoloLogger;
        nodeCommandTasks?: NodeCommandTasks;
        oneShotState?: OneShotState;
        remoteConfig?: RemoteConfigRuntimeStateApi;
        taskList?: TaskList<any, ListrRendererValue, ListrRendererValue>;
        close(): Promise<void>;
        getClusterContext(clusterReference: string): string;
        getClusterReference(): string;
        getNamespace(task: SoloListrTaskWrapper<any>): Promise<NamespaceName>;
        inferMirrorNodeData(
            namespace: NamespaceName,
            context: string,
        ): Promise<
            {
                mirrorNamespace: string;
                mirrorNodeId: number;
                mirrorNodeReleaseName: string;
            },
        >;
        loadRemoteConfigOrWarn(
            argv: { _: string[] } & Record<string, unknown>,
            validate?: boolean,
            skipConsensusNodesValidation?: boolean,
        ): Promise<boolean>;
        resolveNamespaceFromDeployment(
            task?: SoloListrTaskWrapper<any>,
        ): Promise<NamespaceName>;
        run(
            cmd: string,
            arguments_?: string[],
            verbose?: boolean,
            detached?: boolean,
            environmentVariablesToAppend?: Record<string, string>,
            timeoutMs?: number,
        ): Promise<string[]>;
        setupHomeDirectory(directories?: string[]): string[];
        sudoRun(
            sudoRequested: (message: string) => void,
            sudoGranted: (message: string) => void,
            cmd: string,
            arguments_?: string[],
            verbose?: boolean,
            detached?: boolean,
            environmentVariablesToAppend?: Record<string, string>,
        ): Promise<string[]>;
        throwIfNamespaceIsMissing(
            context: string,
            namespace: NamespaceName,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    chartManager? componentFactory? configManager? depManager? helm? k8Factory? leaseManager? localConfig? logger? nodeCommandTasks? oneShotState? remoteConfig? taskList?

    Methods

    close getClusterContext getClusterReference getNamespace inferMirrorNodeData loadRemoteConfigOrWarn resolveNamespaceFromDeployment run setupHomeDirectory sudoRun throwIfNamespaceIsMissing

    Properties

    chartManager?: ChartManager
    componentFactory?: ComponentFactoryApi
    configManager?: ConfigManager
    depManager?: DependencyManager
    helm?: HelmClient
    k8Factory?: K8Factory
    leaseManager?: LockManager
    localConfig?: LocalConfigRuntimeState
    logger?: SoloLogger
    nodeCommandTasks?: NodeCommandTasks
    oneShotState?: OneShotState
    remoteConfig?: RemoteConfigRuntimeStateApi
    taskList?: TaskList<any, ListrRendererValue, ListrRendererValue>

    Methods

    • Parameters

      Returns Promise<
          {
              mirrorNamespace: string;
              mirrorNodeId: number;
              mirrorNodeReleaseName: string;
          },
      >

    • Parameters

      • argv: { _: string[] } & Record<string, unknown>
      • validate: boolean = true
      • skipConsensusNodesValidation: boolean = true

      Returns Promise<boolean>

    • Returns a promise that invokes the shell command

      Parameters

      • cmd: string
      • arguments_: string[] = []
      • verbose: boolean = false
      • detached: boolean = false
      • environmentVariablesToAppend: Record<string, string> = {}
      • OptionaltimeoutMs: number

      Returns Promise<string[]>

    • Parameters

      • sudoRequested: (message: string) => void
      • sudoGranted: (message: string) => void
      • cmd: string
      • arguments_: string[] = []
      • verbose: boolean = false
      • detached: boolean = false
      • environmentVariablesToAppend: Record<string, string> = {}

      Returns Promise<string[]>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods