CloudAPIV2 provides a way to wrap the different calls between version 2 and version 3 of the cloud API.

Hierarchy

  • default

Implements

Constructors

Properties

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

Methods

  • AddCloud adds a new cloud, different from the one managed by the controller.

    Parameters

    Returns Promise<any>

  • AddCredentials adds new credentials. In contrast to UpdateCredentials() below, the new credentials can be for a cloud that the controller does not manage (this is required for CAAS models)

    Parameters

    Returns Promise<ErrorResults>

  • Cloud returns the cloud definitions for the specified clouds.

    Parameters

    Returns Promise<CloudResults>

  • Clouds returns the definitions of all clouds supported by the controller that the logged in user can see.

    Parameters

    • params: any

    Returns Promise<CloudsResult>

  • CredentialContents returns the specified cloud credentials, including the secrets if requested. If no specific credential name/cloud was passed in, all credentials for this user are returned. Only credential owner can see its contents as well as what models use it. Controller admin has no special superpowers here and is treated the same as all other users.

    Parameters

    Returns Promise<CredentialContentResults>

  • DefaultCloud returns the tag of the cloud that models will be created in by default.

    Parameters

    • params: any

    Returns Promise<StringResult>

  • RemoveClouds removes the specified clouds from the controller. If a cloud is in use (has models deployed to it), the removal will fail.

    Parameters

    Returns Promise<ErrorResults>

  • UpdateCredentials updates a set of cloud credentials' content.

    Parameters

    Returns Promise<ErrorResults>

  • UpdateCredentialsCheckModels updates a set of cloud credentials' content. If there are any models that are using a credential and these models are not going to be visible with updated credential content, there will be detailed validation errors per model. Controller admins can 'force' an update of the credential regardless of whether it is deemed valid or not.

    Parameters

    Returns Promise<UpdateCredentialResults>

Generated using TypeDoc