ModelManagerAPIV2 provides a way to wrap the different calls between version 2 and version 3 of the model manager API

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "ModelManager"
VERSION: number = 2
_transport: Transport
NAME: string = "ModelManager"
VERSION: number = 2

Methods

  • CreateModel creates a new model using the account and model config specified in the args.

    Parameters

    Returns Promise<ModelInfo>

  • DestroyModels will try to destroy the specified models. If there is a block on destruction, this method will return an error.

    Parameters

    Returns Promise<ErrorResults>

  • DumpModels will export the models into the database agnostic representation. The user needs to either be a controller admin, or have admin privileges on the model itself.

    Parameters

    Returns Promise<MapResults>

  • DumpModelsDB will gather all documents from all model collections for the specified model. The map result contains a map of collection names to lists of documents represented as maps.

    Parameters

    Returns Promise<MapResults>

  • ListModelSummaries returns models that the specified user has access to in the current server. Controller admins (superuser) can list models for any user. Other users can only ask about their own models.

    Parameters

    Returns Promise<ModelSummaryResults>

  • ListModels returns the models that the specified user has access to in the current server. Controller admins (superuser) can list models for any user. Other users can only ask about their own models.

    Parameters

    Returns Promise<UserModelList>

  • ModelDefaults returns the default config values used when creating a new model.

    Parameters

    • params: any

    Returns Promise<ModelDefaultsResult>

  • ModelStatus is a legacy method call to ensure that we preserve backward compatibility. TODO (anastasiamac 2017-10-26) This should be made obsolete/removed.

    Parameters

    Returns Promise<ModelStatusResults>

  • ValidateModelUpgrades validates if a model is allowed to perform an upgrade. Examples of why you would want to block a model upgrade, would be situations like upgrade-series. If performing an upgrade-series we don't know the current status of the machine, so performing an upgrade-model can lead to bad unintended errors down the line.

    Parameters

    Returns Promise<ErrorResults>

Generated using TypeDoc