org.jenkinsci.plugins.gitclient

Interface SubmoduleUpdateCommand

All Superinterfaces:

GitCommand

public interface SubmoduleUpdateCommand
extends GitCommand

SubmoduleUpdateCommand interface.

Method Summary

Modifier and Type	Method and Description
SubmoduleUpdateCommand	depth(Integer depth) When shallow cloning, allow for a depth to be set in cases where you need more than the immediate last commit.
SubmoduleUpdateCommand	parentCredentials(boolean parentCredentials) If set true and if the git version supports it, use the parent repository credentials when performing a submodule update.
SubmoduleUpdateCommand	recursive(boolean recursive) If set true, submodule update will be recursive.
SubmoduleUpdateCommand	ref(String ref) ref.
SubmoduleUpdateCommand	remoteTracking(boolean remoteTracking) If set true and if the git version supports it, update the submodules to the tip of the branch rather than to a specific SHA1.
SubmoduleUpdateCommand	shallow(boolean shallow) Only clone the most recent history, not preceding history.
SubmoduleUpdateCommand	threads(int threads) Update submodules in parallel with the given number of threads.
SubmoduleUpdateCommand	timeout(Integer timeout) timeout.
SubmoduleUpdateCommand	useBranch(String submodule, String branchname) useBranch.

Methods inherited from interface org.jenkinsci.plugins.gitclient.GitCommand

execute

Method Detail

recursive

SubmoduleUpdateCommand recursive(boolean recursive)

If set true, submodule update will be recursive. Default is non-recursive.

Parameters:

recursive - if true, will recursively update submodules (requires git>=1.6.5)

Returns:

a SubmoduleUpdateCommand object.

remoteTracking

SubmoduleUpdateCommand remoteTracking(boolean remoteTracking)

If set true and if the git version supports it, update the submodules to the tip of the branch rather than to a specific SHA1. Refer to git documentation for details. First available in command line git 1.8.2. Default is to update to a specific SHA1 (compatible with previous versions of git)

Parameters:

remoteTracking - if true, will update the submodule to the tip of the branch requested (requires git>=1.8.2)

Returns:

a SubmoduleUpdateCommand object.

parentCredentials

SubmoduleUpdateCommand parentCredentials(boolean parentCredentials)

If set true and if the git version supports it, use the parent repository credentials when performing a submodule update.

Parameters:

parentCredentials - if true, will use the credentials of the parent project instead of credentials associated with its own URL

Returns:

a SubmoduleUpdateCommand object.

ref

SubmoduleUpdateCommand ref(String ref)

ref.

Parameters:

ref - a String object.

Returns:

a SubmoduleUpdateCommand object.

useBranch

SubmoduleUpdateCommand useBranch(String submodule,
                                 String branchname)

useBranch.

Parameters:

submodule - a String object.

branchname - a String object.

Returns:

a SubmoduleUpdateCommand object.

timeout

SubmoduleUpdateCommand timeout(Integer timeout)

timeout.

Parameters:

timeout - a Integer object.

Returns:

a SubmoduleUpdateCommand object.

shallow

SubmoduleUpdateCommand shallow(boolean shallow)

Only clone the most recent history, not preceding history. Depth of the shallow clone is controlled by the #depth method.

Parameters:

shallow - boolean controlling whether the clone is shallow (requires git>=1.8.4)

Returns:

a SubmoduleUpdateCommand object.

depth

SubmoduleUpdateCommand depth(Integer depth)

When shallow cloning, allow for a depth to be set in cases where you need more than the immediate last commit. Has no effect if shallow is set to false (default).

Parameters:

depth - number of revisions to be included in shallow clone (requires git>=1.8.4)

Returns:

a SubmoduleUpdateCommand object.

threads

SubmoduleUpdateCommand threads(int threads)

Update submodules in parallel with the given number of threads. Note that this parallelism only applies to the top-level submodules of a repository. Any submodules of those submodules will be updated serially.

Parameters:

threads - number of threads to use for updating submodules in parallel

Returns:

a SubmoduleUpdateCommand object.