Package com.comsol.api.database.param

Interface CreateBranchParam

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String commitComment()
      Get the comment for the initial commit that will be saved for the new branch.
      java.util.Collection<ItemKey> itemKeys()
      Get the identifying keys of items in the source branch selected to be included in the new branch.
      ItemSearchIndexingMode itemSearchIndexingMode()
      Get the mode used when indexing search data for the latest item versions in the branch.
      java.lang.String name()
      Get the name for the new branch.
      BranchKey sourceBranchKey()
      Get the identifying key of the source branch that the new branch will be created from.
      CommitKey sourceCommitKey()
      Get the identifying key of a commit in the source branch that the new branch will be created from.

    • Method Detail

      • name

        java.lang.String name()
        Get the name for the new branch.
        Returns:
        The name for the new branch.

      • sourceBranchKey

        BranchKey sourceBranchKey()
        Get the identifying key of the source branch that the new branch will be created from. The new branch will be created from the commit that is currently the latest one in the source branch. Returns null if the new branch is created from a fixed source commit.
        Returns:
        The identifying key of the source branch that the new branch will be created from, or null.

      • sourceCommitKey

        CommitKey sourceCommitKey()
        Get the identifying key of a commit in the source branch that the new branch will be created from. Returns null if the source for the new branch is implicitly specified as the latest commit in the source branch.
        Returns:
        The identifying key of the commit in the source branch that the new branch will be created from, or null.

      • itemSearchIndexingMode

        ItemSearchIndexingMode itemSearchIndexingMode()
        Get the mode used when indexing search data for the latest item versions in the branch. The mode defaults to ItemSearchIndexingMode.ITEM_FIELDS_AND_CONTENTS if this returns null.
        Returns:
        The mode used when indexing search data for the latest item versions in the branch, or null to use a default mode.

      • commitComment

        java.lang.String commitComment()
        Get the comment for the initial commit that will be saved for the new branch.
        Returns:
        An optional commit comment, or null.

      • itemKeys

        java.util.Collection<ItemKey> itemKeys()
        Get the identifying keys of items in the source branch selected to be included in the new branch. Returns null if all items should be included in the new branch. Returns an empty collection if no items should be included.
        Returns:
        The identifying keys of items selected to be included in the new branch, or null if all items are included.