com.offbytwo.jenkins.model.credentials

Class Credential

java.lang.Object

com.offbytwo.jenkins.model.BaseModel

com.offbytwo.jenkins.model.credentials.Credential

Direct Known Subclasses:

AppleDeveloperProfileCredential, CertificateCredential, SecretTextCredential, SSHKeyCredential, UsernamePasswordCredential

public abstract class Credential
extends BaseModel

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	SCOPE_GLOBAL

Fields inherited from class com.offbytwo.jenkins.model.BaseModel

client

Constructor Summary

Constructors

Constructor and Description
Credential()

Method Summary

Modifier and Type	Method and Description
abstract Map<String,Object>	dataForCreate()
abstract Map<String,Object>	dataForUpdate()
String	getDescription()
String	getDisplayName()
String	getFullName()
String	getId()
String	getScope()
String	getTypeName()
void	setDescription(String description)
void	setDisplayName(String displayName) Should not be used.
void	setFullName(String fullName) Should not be used.
void	setId(String id) Set the id of the credential.
void	setScope(String scope) Set the scope of the credential.
void	setTypeName(String typeName) Should not be used.
boolean	useMultipartForm() Indicate if the request should be sent as multipart/form data

Methods inherited from class com.offbytwo.jenkins.model.BaseModel

get_class, getClient, setClient

Methods inherited from class java.lang.Object

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

Field Detail

SCOPE_GLOBAL

protected static final String SCOPE_GLOBAL

See Also:

Constant Field Values

Constructor Detail

Credential

public Credential()

Method Detail

getScope

public String getScope()

setScope

public void setScope(String scope)

Set the scope of the credential. It is "GLOBAL" by default. Should not be changed.

Parameters:

scope -

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getId

public String getId()

setId

public void setId(String id)

Set the id of the credential. When creating a new credential, if this is not provided, a random id will be generated by Jenkins. Required for update and delete operations

Parameters:

id - the id of the credential.

getFullName

public String getFullName()

setFullName

public void setFullName(String fullName)

Should not be used. The value is set by Jenkins.

Parameters:

fullName -

getTypeName

public String getTypeName()

setTypeName

public void setTypeName(String typeName)

Should not be used. The value is set by Jenkins.

Parameters:

typeName -

getDisplayName

public String getDisplayName()

setDisplayName

public void setDisplayName(String displayName)

Should not be used. The value is set by Jenkins

Parameters:

displayName -

dataForCreate

public abstract Map<String,Object> dataForCreate()

dataForUpdate

public abstract Map<String,Object> dataForUpdate()

useMultipartForm

public boolean useMultipartForm()

Indicate if the request should be sent as multipart/form data

Returns: