ControllerAPI provides the Controller API.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "Controller"
VERSION: number = 9
_transport: Transport
NAME: string = "Controller"
VERSION: number = 9

Methods

  • AllModels allows controller administrators to get the list of all the models in the controller.

    Parameters

    • params: any

    Returns Promise<UserModelList>

  • ConfigSet changes the value of specified controller configuration settings. Only some settings can be changed after bootstrap. Settings that aren't specified in the params are left unchanged.

    Parameters

    Returns Promise<any>

  • ControllerConfig returns the controller's configuration.

    Parameters

    • params: any

    Returns Promise<ControllerConfigResult>

  • ControllerVersion returns the version information associated with this controller binary.

    NOTE: the implementation intentionally does not check for SuperuserAccess as the Version is known even to users with login access.

    Parameters

    • params: any

    Returns Promise<ControllerVersionResults>

  • DestroyController destroys the controller.

    If the args specify the destruction of the models, this method will attempt to do so. Otherwise, if the controller has any non-empty, non-Dead hosted models, then an error with the code params.CodeHasHostedModels will be transmitted.

    Parameters

    Returns Promise<any>

  • GetCloudSpec constructs the CloudSpec for a validated and authorized model.

    Parameters

    Returns Promise<CloudSpecResult>

  • GetControllerAccess returns the level of access the specified users have on the controller.

    Parameters

    Returns Promise<UserAccessResults>

  • HostedModelConfigs returns all the information that the client needs in order to connect directly with the host model's provider and destroy it directly.

    Parameters

    • params: any

    Returns Promise<HostedModelConfigsResults>

  • IdentityProviderURL returns the URL of the configured external identity provider for this controller or an empty string if no external identity provider has been configured when the controller was bootstrapped.

    NOTE: the implementation intentionally does not check for SuperuserAccess as the URL is known even to users with login access.

    Parameters

    • params: any

    Returns Promise<StringResult>

  • ListBlockedModels returns a list of all models on the controller which have a block in place. The resulting slice is sorted by model name, then owner. Callers must be controller administrators to retrieve the list.

    Parameters

    • params: any

    Returns Promise<ModelBlockInfoList>

  • ModelConfig returns the model config for the controller model. For information on the current model, use client.ModelGet

    Parameters

    • params: any

    Returns Promise<ModelConfigResults>

  • MongoVersion allows the introspection of the mongo version per controller

    Parameters

    • params: any

    Returns Promise<StringResult>

  • RemoveBlocks removes all the blocks in the controller.

    Parameters

    Returns Promise<any>

  • WatchAllModelSummaries starts watching the summary updates from the cache. This method is superuser access only, and watches all models in the controller.

    Parameters

    • params: any

    Returns Promise<SummaryWatcherID>

  • WatchAllModels starts watching events for all models in the controller. The returned AllWatcherId should be used with Next on the AllModelWatcher endpoint to receive deltas.

    Parameters

    • params: any

    Returns Promise<AllWatcherId>

  • WatchModelSummaries starts watching the summary updates from the cache. Only models that the user has access to are returned.

    Parameters

    • params: any

    Returns Promise<SummaryWatcherID>

Generated using TypeDoc