org.jenkinsci.plugins.gitclient

Interface CloneCommand

All Superinterfaces:

GitCommand

public interface CloneCommand
extends GitCommand

Command to clone a repository. This command behaves differently from CLI clone command, it never actually checks out into the workspace.

Method Summary

Modifier and Type	Method and Description
CloneCommand	depth(Integer depth) When shallow cloning, allow for a depth to be set in cases where you need more than the immediate last commit.
CloneCommand	noCheckout() Deprecated.
CloneCommand	reference(String reference) reference.
CloneCommand	refspecs(List<RefSpec> refspecs)
CloneCommand	repositoryName(String name) Name of the remote, such as 'origin' (which is the default.)
CloneCommand	shallow() shallow.
CloneCommand	shared() When the repository to clone is on the local machine, instead of using hard links, automatically setup .git/objects/info/alternates to share the objects with the source repository
CloneCommand	tags(boolean tags)
CloneCommand	timeout(Integer timeout) timeout.
CloneCommand	url(String url) url.

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

execute

Method Detail

url

CloneCommand url(String url)

url.

Parameters:

url - a String object.

Returns:

a CloneCommand object.

repositoryName

CloneCommand repositoryName(String name)

Name of the remote, such as 'origin' (which is the default.)

Parameters:

name - a String object.

Returns:

a CloneCommand object.

shallow

CloneCommand shallow()

shallow.

Returns:

a CloneCommand object.

shared

CloneCommand shared()

When the repository to clone is on the local machine, instead of using hard links, automatically setup .git/objects/info/alternates to share the objects with the source repository

Returns:

a CloneCommand object.

reference

CloneCommand reference(String reference)

reference.

Parameters:

reference - a String object.

Returns:

a CloneCommand object.

timeout

CloneCommand timeout(Integer timeout)

timeout.

Parameters:

timeout - a Integer object.

Returns:

a CloneCommand object.

noCheckout

@Deprecated
CloneCommand noCheckout()

Deprecated.

When we just need to clone repository without populating the workspace (for instance when sparse checkouts are used). This parameter does not do anything, a checkout will never be performed.

Returns:

a CloneCommand object.

tags

CloneCommand tags(boolean tags)

refspecs

CloneCommand refspecs(List<RefSpec> refspecs)

depth

CloneCommand 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

Returns:

a CloneCommand object.