com.cloudbees.plugins.credentials.common

Interface StandardCredentials

All Superinterfaces:

Credentials, hudson.model.Describable<Credentials>, hudson.ExtensionPoint, IdCredentials, Serializable

All Known Subinterfaces:

StandardCertificateCredentials, StandardUsernameCredentials, StandardUsernamePasswordCredentials

All Known Implementing Classes:

BaseStandardCredentials, CertificateCredentialsImpl, UsernamePasswordCredentialsImpl

@Recommended(since="1.6")
 @NameWith(value=StandardCredentials.NameProvider.class,
          priority=-16)
public interface StandardCredentials
extends IdCredentials

Credentials that have a description to help the user differentiate the specific credential from a collection of Credentials and an ID to help Jenkins locate the specific credential from a collection of Credentials. Most credentials should aim to implement this interface.

Since:

1.6

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StandardCredentials.NameProvider Our name provider.

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

IdCredentials.Helpers

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the Description.

Methods inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

getId

Methods inherited from interface com.cloudbees.plugins.credentials.Credentials

getDescriptor, getScope

Method Detail

getDescription

@NonNull
String getDescription()

Returns the Description.

Returns:

the Description.