API is the concrete implementation of the API endpoint.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "ModelGeneration"
VERSION: number = 4
_transport: Transport
NAME: string = "ModelGeneration"
VERSION: number = 4

Methods

  • AbortBranch aborts the input branch, marking it complete. However no changes are made applicable to the whole model. No units may be assigned to the branch when aborting.

    Parameters

    Returns Promise<ErrorResult>

  • AddBranch adds a new branch with the input name to the model.

    Parameters

    Returns Promise<ErrorResult>

  • BranchInfo will return details of branch identified by the input argument, including units on the branch and the configuration disjoint with the master generation. An error is returned if no in-flight branch matching in input is found.

    Parameters

    Returns Promise<BranchResults>

  • CommitBranch commits the input branch, making its changes applicable to the whole model and marking it complete.

    Parameters

    Returns Promise<IntResult>

  • HasActiveBranch returns a true result if the input model has an "in-flight" branch matching the input name.

    Parameters

    Returns Promise<BoolResult>

  • ListCommits will return the commits, hence only branches with generation_id higher than 0

    Parameters

    • params: any

    Returns Promise<BranchResults>

  • ShowCommit will return details a commit given by its generationId An error is returned if either no branch can be found corresponding to the generation id. Or the generation id given is below 1.

    Parameters

    Returns Promise<GenerationResult>

  • TrackBranch marks the input units and/or applications as tracking the input branch, causing them to realise changes made under that branch.

    Parameters

    Returns Promise<ErrorResults>

Generated using TypeDoc