org.jenkinsci.plugins.gitclient

Interface FetchCommand

All Superinterfaces:

GitCommand

public interface FetchCommand
extends GitCommand

FetchCommand interface.

Method Summary

Modifier and Type	Method and Description
FetchCommand	depth(Integer depth) When shallow cloning, allow for a depth to be set in cases where you need more than the immediate last commit.
FetchCommand	from(URIish remote, List<RefSpec> refspecs) from.
FetchCommand	prune() Deprecated. favour prune(boolean)
FetchCommand	prune(boolean prune) prune.
FetchCommand	shallow(boolean shallow) shallow.
FetchCommand	tags(boolean tags)
FetchCommand	timeout(Integer timeout) timeout.

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

execute

Method Detail

from

FetchCommand from(URIish remote,
                  List<RefSpec> refspecs)

from.

Parameters:

remote - a URIish object.

refspecs - a List object.

Returns:

a FetchCommand object.

prune

@Deprecated
FetchCommand prune()

Deprecated. favour prune(boolean)

prune.

Returns:

a FetchCommand object.

prune

FetchCommand prune(boolean prune)

prune.

Parameters:

prune - true if the fetch should prune.

Returns:

a FetchCommand object.

Since:

2.5.0

shallow

FetchCommand shallow(boolean shallow)

shallow.

Parameters:

shallow - a boolean.

Returns:

a FetchCommand object.

timeout

FetchCommand timeout(Integer timeout)

timeout.

Parameters:

timeout - a Integer object.

Returns:

a FetchCommand object.

tags

FetchCommand tags(boolean tags)

depth

FetchCommand 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.