Package com.comsol.api.database.param

Interface DatabaseApiParamGenerators

  • public interface DatabaseApiParamGenerators

    Factory for generators of input parameters to be used in the Model Manager database API when performing advanced database operations.

    Use one of the with<parameter-option> methods on a returned generator to specify an input option for a database operation. The return value of such a with-method is a new generator on which another with-method may be invoked. Once all options have been specified in this way, the final generator can be passed as an argument to the corresponding API method as the method's input parameter object.

    • Method Detail

      • forQueryDatabaseConfigurations

        QueryDatabaseConfigurationsParamGenerator forQueryDatabaseConfigurations()
        Get a generator for input parameters used when querying Model Manager database configurations.
        Returns:
        A generator for input parameters used when querying Model Manager database configurations.

      • forQueryRepositories

        QueryRepositoriesParamGenerator forQueryRepositories()
        Get a generator for input parameters used when querying the repositories in a Model Manager database.
        Returns:
        A generator for input parameters used when querying the repositories in a Model Manager database.

      • forCreateRepository

        CreateRepositoryParamGenerator forCreateRepository()
        Get a generator for input parameters used when creating a new repository in a Model Manager database.
        Returns:
        A generator for input parameters used when creating a new repository in a Model Manager database.

      • forUpdateRepository

        UpdateRepositoryParamGenerator forUpdateRepository()
        Get a generator for input parameters used when updating the settings of a repository in a Model Manager database (including, for example, renaming the repository).
        Returns:
        A generator for input parameters used when updating the settings of a repository in a Model Manager database (including, for example, renaming the repository).

      • forDeleteRepositories

        DeleteRepositoriesParamGenerator forDeleteRepositories()
        Get a generator for input parameters used when deleting repositories in a database.
        Returns:
        A generator for input parameters used when deleting repositories in a database.

      • forRestoreRepositories

        RestoreRepositoriesParamGenerator forRestoreRepositories()
        Get a generator for input parameters used when restoring repositories in a database.
        Returns:
        A generator for input parameters used when restoring repositories in a database.

      • forQueryBranches

        QueryBranchesParamGenerator forQueryBranches()
        Get a generator for input parameters used when querying the branches in a repository.
        Returns:
        A generator for input parameters used when querying the branches in a repository.

      • forCreateBranch

        CreateBranchParamGenerator forCreateBranch()
        Get a generator for input parameters used when creating a new branch in a repository.
        Returns:
        A generator for input parameters used when creating a new branch in a repository.

      • forUpdateBranch

        UpdateBranchParamGenerator forUpdateBranch()
        Get a generator for input parameters used when updating the settings of a branch in a repository (including, for example, renaming the branch).
        Returns:
        A generator for input parameters used when updating the settings of a branch in a repository (including, for example, renaming the branch).

      • forDeleteBranches

        DeleteBranchesParamGenerator forDeleteBranches()
        Get a generator for input parameters used when deleting branches in a repository.
        Returns:
        A generator for input parameters used when deleting branches in a repository.

      • forRestoreBranches

        RestoreBranchesParamGenerator forRestoreBranches()
        Get a generator for input parameters used when restoring branches in a repository.
        Returns:
        A generator for input parameters used when restoring branches in a repository.

      • forQuerySnapshots

        QuerySnapshotsParamGenerator forQuerySnapshots()
        Get a generator for input parameters used when querying the snapshots in a repository.
        Returns:
        A generator for input parameters used when querying the snapshots in a repository.

      • forCreateSnapshot

        CreateSnapshotParamGenerator forCreateSnapshot()
        Get a generator for input parameters used when creating a new snapshot in a repository.
        Returns:
        A generator for input parameters used when creating a new snapshot in a repository.

      • forUpdateSnapshot

        UpdateSnapshotParamGenerator forUpdateSnapshot()
        Get a generator for input parameters used when updating the settings of a snapshot in a repository (including, for example, renaming the snapshot).
        Returns:
        A generator for input parameters used when updating the settings of a snapshot in a repository (including, for example, renaming the snapshot).

      • forDeleteSnapshots

        DeleteSnapshotsParamGenerator forDeleteSnapshots()
        Get a generator for input parameters used when deleting snapshots in a repository.
        Returns:
        A generator for input parameters used when deleting snapshots in a repository.

      • forRestoreSnapshots

        RestoreSnapshotsParamGenerator forRestoreSnapshots()
        Get a generator for input parameters used when restoring snapshots in a repository.
        Returns:
        A generator for input parameters used when restoring snapshots in a repository.

      • forSearchItemsForBranch

        SearchItemsForBranchParamGenerator forSearchItemsForBranch()
        Get a generator for input parameters used when searching the latest item versions in a branch.
        Returns:
        A generator for input parameters used when searching the latest item versions in a branch.

      • forSearchItemsForCommit

        SearchItemsForCommitParamGenerator forSearchItemsForCommit()
        Get a generator for input parameters used when searching the item versions that were the latest at the point in time when a commit was saved in a branch.
        Returns:
        A generator for input parameters used when searching the item versions that were the latest at the point in time when a commit was saved in a branch.

      • forSearchItemVersions

        SearchItemVersionsParamGenerator forSearchItemVersions()
        Get a generator for input parameters used when searching item versions in a Model Manager database. This includes both latest item versions and historical item versions.
        Returns:
        A generator for input parameters used when searching item versions in a Model Manager database.

      • forQueryCommitHistory

        QueryCommitHistoryParamGenerator forQueryCommitHistory()
        Get a generator for input parameters used when querying the history of all saved commits in a branch.
        Returns:
        A generator for input parameters used when querying the history of all saved commits in a branch.

      • forUpdateCommit

        UpdateCommitParamGenerator forUpdateCommit()
        Get a generator for input parameters used when updating the settings of a commit (including, for example, modifying the comment associated with the commit).
        Returns:
        A generator for input parameters used when updating the settings of a commit (including, for example, modifying the comment associated with the commit).

      • forQueryItemsWithTagAssignment

        QueryItemsWithTagAssignmentParamGenerator forQueryItemsWithTagAssignment()
        Get a generator for input parameters used when querying for items assigned a particular tag.
        Returns:
        A generator for input parameters used when querying for items assigned a particular tag.

      • forQueryItemVersions

        QueryItemVersionParamGenerator forQueryItemVersions()
        Get a generator for input parameters used when querying for item versions associated with an item.
        Returns:
        A generator for input parameters used when querying for item versions associated with an item.

      • forQueryItemVersionReferences

        QueryItemVersionReferencesParamGenerator forQueryItemVersionReferences()
        Get a generator for input parameters used when querying the item versions that are either referencing, or that are referenced by, a particular item version.
        Returns:
        A generator for input parameters used when querying the item versions that are either referencing, or that are referenced by, a particular item version.

      • forNewFileLocationUri

        NewFileLocationUriParamGenerator forNewFileLocationUri()
        Get a generator for input parameters used when creating a file location URI that represents a file resource belonging to a new, but not yet created, file item.
        Returns:
        A generator for input parameters used when creating a file location URI that represents a file resource belonging to a new, but not yet created, file item.

      • forSaveTag

        SaveTagItemParamGenerator forSaveTag()
        Get a generator for input parameters used when creating a new, or updating an existing, tag item.
        Returns:
        A generator for input parameters used when creating a new, or updating an existing, tag item.

      • forUpdateTag

        UpdateTagItemParamGenerator forUpdateTag()
        Get a generator for input parameters used when updating an existing tag item (including, for example, updating its title or assigned parent tags).
        Returns:
        A generator for input parameters used when updating an existing tag item (including, for example, updating its title or assigned parent tags).

      • forSaveModel

        SaveModelItemParamGenerator forSaveModel()
        Get a generator for input parameters used when creating a new, or updating an existing, model item.
        Returns:
        A generator for input parameters used when creating a new, or updating an existing, model item.

      • forUpdateModel

        UpdateModelItemParamGenerator forUpdateModel()
        Get a generator for input parameters used when updating an existing model item (including, for example, updating its title, description, or assigned tags).
        Returns:
        A generator for input parameters used used when updating an existing model item (including, for example, updating its title, filename, description, or assigned tags).

      • forSaveFile

        SaveFileItemParamGenerator forSaveFile()
        Get a generator for input parameters used when creating a new, or updating an existing, file item.
        Returns:
        A generator for input parameters used when creating a new, or updating an existing, file item.

      • forUpdateFile

        UpdateFileItemParamGenerator forUpdateFile()
        Get a generator for input parameters used when updating an existing file item (including, for example, updating its title, description, or assigned tags).
        Returns:
        A generator for input parameters used when updating an existing file item (including, for example, updating its title, description, or assigned tags).

      • forSourceFile

        SourceFileParamGenerator forSourceFile()
        Get a generator for input parameters used when specifying a source for the underlying file resource contents of a file item version to be saved.
        Returns:
        A generator for input parameters used when specifying a source for the underlying file resource contents of a file item version to be saved.

      • forSetAssignedTags

        SetAssignedTagsParamGenerator forSetAssignedTags()
        Get a generator for input parameters used when updating the assigned tags of an item.
        Returns:
        A generator for input parameters used when updating the assigned tags of an item.

      • forAssignTagToItems

        AssignTagToItemsParamGenerator forAssignTagToItems()
        Get a generator for input parameters used when assigning a tag to one or more items.
        Returns:
        A generator for input parameters used when assigning a tag to one or more items.

      • forUnassignTagFromItems

        UnassignTagFromItemsParamGenerator forUnassignTagFromItems()
        Get a generator for input parameters used when unassigning a tag from one or more items.
        Returns:
        A generator for input parameters used when unassigning a tag from one or more items.

      • forDeleteItem

        DeleteItemParamGenerator forDeleteItem()
        Get a generator for input parameters used when deleting an item.
        Returns:
        A generator for input parameters used when deleting an item.

      • forSaveCommit

        SaveCommitParamGenerator forSaveCommit()
        Get a generator for input parameters used when saving a general commit in a branch involving one or more items (including, for example, saving item versions, modifying the assigned tags of items, and deleting items).
        Returns:
        A generator for input parameters used when saving a general commit in a branch involving one or more items (including, for example, saving item versions, modifying the assigned tags of items, and deleting items).

      • forExportModelVersion

        ExportModelItemVersionParamGenerator forExportModelVersion()
        Get a generator for input parameters used when exporting a model version from a Model Manager database.
        Returns:
        A generator for input parameters used when exporting a model version from a Model Manager database.

      • forExportFileVersion

        ExportFileItemVersionParamGenerator forExportFileVersion()
        Get a generator for input parameters used when exporting file resource contents of a file version from a Model Manager database.
        Returns:
        A generator for input parameters used when exporting file resource contents of a file version from a Model Manager database.