org.jenkinsci.plugins.gitclient

Interface CheckoutCommand

All Superinterfaces:

GitCommand

public interface CheckoutCommand
extends GitCommand

CheckoutCommand interface.

Method Summary

Modifier and Type	Method and Description
CheckoutCommand	branch(String branch) branch.
CheckoutCommand	deleteBranchIfExist(boolean deleteBranch) deleteBranchIfExist.
CheckoutCommand	lfsRemote(String lfsRemote) Call "git lfs pull" for the given remote after checkout.
CheckoutCommand	ref(String ref) ref.
CheckoutCommand	sparseCheckoutPaths(List<String> sparseCheckoutPaths) sparseCheckoutPaths.
CheckoutCommand	timeout(Integer timeout) timeout.

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

execute

Method Detail

ref

CheckoutCommand ref(String ref)

ref.

Parameters:

ref - a String object.

Returns:

a CheckoutCommand object.

branch

CheckoutCommand branch(String branch)

branch.

Parameters:

branch - a String object.

Returns:

a CheckoutCommand object.

deleteBranchIfExist

CheckoutCommand deleteBranchIfExist(boolean deleteBranch)

deleteBranchIfExist.

Parameters:

deleteBranch - a boolean.

Returns:

a CheckoutCommand object.

sparseCheckoutPaths

CheckoutCommand sparseCheckoutPaths(List<String> sparseCheckoutPaths)

sparseCheckoutPaths.

Parameters:

sparseCheckoutPaths - a List object.

Returns:

a CheckoutCommand object.

timeout

CheckoutCommand timeout(Integer timeout)

timeout.

Parameters:

timeout - a Integer object.

Returns:

a CheckoutCommand object.

lfsRemote

CheckoutCommand lfsRemote(String lfsRemote)

Call "git lfs pull" for the given remote after checkout.

Parameters:

lfsRemote - name of the remote used for git lfs operations (typically "origin").

Returns:

a CheckoutCommand object.