io.jenkins.plugins.checks.github

类 GitHubSCMFacade

java.lang.Object

io.jenkins.plugins.checks.github.GitHubSCMFacade

public class GitHubSCMFacade
extends Object

Facade to GitHub SCM in Jenkins, used for finding GitHub SCM of a job.

构造器概要

构造器

构造器和说明
GitHubSCMFacade()

方法概要

限定符和类型	方法和说明
Optional<org.jenkinsci.plugins.github_branch_source.GitHubAppCredentials>	findGitHubAppCredentials(Job<?,?> job, String credentialsId) Find GitHubAppCredentials with the credentialsId used by the job.
Optional<org.jenkinsci.plugins.github_branch_source.GitHubSCMSource>	findGitHubSCMSource(Job<?,?> job) Find GitHubSCMSource (or GitHub repository) used by the job.
Optional<jenkins.scm.api.SCMHead>	findHead(Job<?,?> job) Find SCMHead (or branch) used by the job.
Optional<jenkins.scm.api.SCMRevision>	findRevision(org.jenkinsci.plugins.github_branch_source.GitHubSCMSource source, jenkins.scm.api.SCMHead head) Fetch the current SCMRevision used by the head of the source.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

GitHubSCMFacade

public GitHubSCMFacade()

方法详细资料

findGitHubSCMSource

public Optional<org.jenkinsci.plugins.github_branch_source.GitHubSCMSource> findGitHubSCMSource(Job<?,?> job)

Find GitHubSCMSource (or GitHub repository) used by the job.

参数:

job - the Jenkins project

返回:

the found GitHub SCM source used or empty

findGitHubAppCredentials

public Optional<org.jenkinsci.plugins.github_branch_source.GitHubAppCredentials> findGitHubAppCredentials(Job<?,?> job,
                                                                                                          String credentialsId)

Find GitHubAppCredentials with the credentialsId used by the job.

参数:

job - the Jenkins project

credentialsId - the id of the target credentials

返回:

the found GitHub App credentials or empty

findHead

public Optional<jenkins.scm.api.SCMHead> findHead(Job<?,?> job)

Find SCMHead (or branch) used by the job.

参数:

job - the Jenkins project

返回:

the found SCM head or empty

findRevision

public Optional<jenkins.scm.api.SCMRevision> findRevision(org.jenkinsci.plugins.github_branch_source.GitHubSCMSource source,
                                                          jenkins.scm.api.SCMHead head)

Fetch the current SCMRevision used by the head of the source.

参数:

source - the GitHub repository

head - the branch

返回:

the fetched revision or empty