Package com.comsol.api.database.param

Interface CreateBranchParamGenerator

All Superinterfaces:

CreateBranchParam, DatabaseApiValue

public interface CreateBranchParamGenerator
extends CreateBranchParam

A generator for input parameters used when creating a new branch in a repository.

Method Summary

Modifier and Type	Method	Description
CreateBranchParamGenerator	withCommitComment(java.lang.String commitComment)	Set the comment for the initial commit that will be saved for the new branch.
default CreateBranchParamGenerator	withItemKeys(ItemKey... itemKeys)	Specify the identifying keys of a subset of items from the source branch that will be included in the new branch.
CreateBranchParamGenerator	withItemKeys(java.util.Collection<ItemKey> itemKeys)	Specify the identifying keys of a subset of items from the source branch that will be included in the new branch.
CreateBranchParamGenerator	withItemSearchIndexingMode(ItemSearchIndexingMode itemSearchIndexingMode)	Set the mode used when indexing search data for the latest item versions in the branch.
CreateBranchParamGenerator	withName(java.lang.String name)	Set the name for the new branch.
CreateBranchParamGenerator	withSourceBranchKey(BranchKey sourceBranchKey)	Set the identifying key of a source branch that the new branch will be created from.
CreateBranchParamGenerator	withSourceCommitKey(CommitKey sourceCommitKey)	Set the identifying key of a fixed commit in the source branch that the new branch will be created from.

Methods inherited from interface com.comsol.api.database.param.CreateBranchParam

commitComment, itemKeys, itemSearchIndexingMode, name, sourceBranchKey, sourceCommitKey

Method Detail

withName

CreateBranchParamGenerator withName(java.lang.String name)

Set the name for the new branch.

Parameters:

name - The new name for the branch.

Returns:

A copy of this instance.

withSourceBranchKey

CreateBranchParamGenerator withSourceBranchKey(BranchKey sourceBranchKey)

Set the identifying key of a 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. Skip if the new branch is created from a fixed source commit as specified via withSourceCommitKey(CommitKey).

Parameters:

sourceBranchKey - The identifying key of a source branch.

Returns:

A copy of this instance.

withSourceCommitKey

CreateBranchParamGenerator withSourceCommitKey(CommitKey sourceCommitKey)

Set the identifying key of a fixed commit in the source branch that the new branch will be created from. Skip if the new branch is created from the latest commit in the source branch as specified via withSourceBranchKey(BranchKey).

Parameters:

sourceCommitKey - The identifying key of a source commit.

Returns:

A copy of this instance.

withItemSearchIndexingMode

CreateBranchParamGenerator withItemSearchIndexingMode(ItemSearchIndexingMode itemSearchIndexingMode)

Set the mode used when indexing search data for the latest item versions in the branch. Skip to use ItemSearchIndexingMode.ITEM_FIELDS_AND_CONTENTS.

Parameters:

itemSearchIndexingMode - The mode used when indexing search data for the latest item versions in the branch.

Returns:

A copy of this instance.

withCommitComment

CreateBranchParamGenerator withCommitComment(java.lang.String commitComment)

Set the comment for the initial commit that will be saved for the new branch. May be skipped.

Parameters:

commitComment - An optional commit comment.

Returns:

A copy of this instance.

withItemKeys

default CreateBranchParamGenerator withItemKeys(ItemKey... itemKeys)

Specify the identifying keys of a subset of items from the source branch that will be included in the new branch. Pass an empty collection to not include any items from the source branch. Skip to include all items from the source branch.

Parameters:

itemKeys - The identifying keys of items in the source branch.

Returns:

A copy of this instance.

withItemKeys

CreateBranchParamGenerator withItemKeys(java.util.Collection<ItemKey> itemKeys)

Specify the identifying keys of a subset of items from the source branch that will be included in the new branch. Pass an empty collection to not include any items from the source branch. Skip to include all items from the source branch.

Parameters:

itemKeys - The identifying keys of items in the source branch.

Returns:

A copy of this instance.