Class GitHubAppCredentials
- java.lang.Object
-
- com.cloudbees.plugins.credentials.BaseCredentials
-
- com.cloudbees.plugins.credentials.impl.BaseStandardCredentials
-
- org.jenkinsci.plugins.github_branch_source.GitHubAppCredentials
-
- All Implemented Interfaces:
com.cloudbees.plugins.credentials.common.IdCredentials
,com.cloudbees.plugins.credentials.common.PasswordCredentials
,com.cloudbees.plugins.credentials.common.StandardCredentials
,com.cloudbees.plugins.credentials.common.StandardUsernameCredentials
,com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials
,com.cloudbees.plugins.credentials.common.UsernameCredentials
,com.cloudbees.plugins.credentials.common.UsernamePasswordCredentials
,com.cloudbees.plugins.credentials.Credentials
,ExtensionPoint
,Describable<com.cloudbees.plugins.credentials.Credentials>
,Serializable
public class GitHubAppCredentials extends com.cloudbees.plugins.credentials.impl.BaseStandardCredentials implements com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GitHubAppCredentials.DescriptorImpl
-
Nested classes/interfaces inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials
com.cloudbees.plugins.credentials.impl.BaseStandardCredentials.BaseStandardCredentialsDescriptor
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials
com.cloudbees.plugins.credentials.common.IdCredentials.Helpers
-
-
Constructor Summary
Constructors Constructor Description GitHubAppCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, String appID, Secret privateKey)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.cloudbees.plugins.credentials.Credentials
forRun(Run<?,?> context)
String
getApiUri()
String
getAppID()
String
getOwner()
Owner of this installation, i.e.Secret
getPassword()
Secret
getPrivateKey()
String
getUsername()
void
setApiUri(String apiUri)
void
setOwner(String owner)
GitHubAppCredentials
withOwner(String owner)
-
Methods inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials
equals, getDescription, getId, hashCode
-
Methods inherited from class com.cloudbees.plugins.credentials.BaseCredentials
getDescriptor, getScope
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.cloudbees.plugins.credentials.Credentials
getDescriptor, getScope
-
-
-
-
Method Detail
-
getApiUri
public String getApiUri()
-
setApiUri
@DataBoundSetter public void setApiUri(String apiUri)
-
getAppID
@NonNull public String getAppID()
-
getPrivateKey
@NonNull public Secret getPrivateKey()
-
getOwner
@CheckForNull public String getOwner()
Owner of this installation, i.e. a user or organisation, used to differeniate app installations when the app is installed to multiple organisations / users.If this is null then call listInstallations and if there's only one in the list then use that installation.
- Returns:
- the owner of the organisation or null.
-
setOwner
@DataBoundSetter public void setOwner(String owner)
-
getPassword
@NonNull public Secret getPassword()
- Specified by:
getPassword
in interfacecom.cloudbees.plugins.credentials.common.PasswordCredentials
-
getUsername
@NonNull public String getUsername()
- Specified by:
getUsername
in interfacecom.cloudbees.plugins.credentials.common.UsernameCredentials
-
withOwner
@NonNull public GitHubAppCredentials withOwner(@NonNull String owner)
-
forRun
@NonNull public com.cloudbees.plugins.credentials.Credentials forRun(Run<?,?> context)
- Specified by:
forRun
in interfacecom.cloudbees.plugins.credentials.Credentials
-
-