This section describes the intrinsic properties for some of the objects in the CloudBees CD/RO. The property’s type precedes each property description in the Description column.
Property type | Definition |
---|---|
boolean |
One of two possible values—either true or false. These values are more frequently represented by the numbers "0" and "1", where "0" equals false and "1" equals true. |
date |
A millisecond precision UTC date in ISO 8601 form: |
id |
Each time an object is created, CloudBees CD/RO generates a unique ID number for that object. |
name |
This is a unicode string value with a maximum of 255 characters. |
number |
This is a simple integer numeric value. |
reference |
This property refers to another object. |
string |
This is a unicode string value with a maximum CLOB size of the database, but only the first 450 characters are indexed, which means a defined search will not "see" beyond the first 450 characters. |
In the following tables, the Description column displays the property type followed by the property description.
acl
An acl
is an Access Control List.
Property Name | Description |
---|---|
aclId |
|
inheriting |
|
ownerType |
This is any type of object the ACL controls and can be any of the objects listed below:
|
parentId |
|
artifact
An artifact is an object that contains zero or more artifact versions. An artifact has two purposes: 1. To group artifact versions and provide a template for naming the versions 2. To restrict who can publish artifact versions, based on groupId:artifactKey
Property Name | Description |
---|---|
acl |
|
artifactId |
|
artifactKey |
|
artifactName |
|
artifactVersionNameTemplate |
|
createTime |
|
description |
|
groupId |
|
lastModifiedBy |
|
modifyTime |
|
owner |
|
propertySheet |
|
artifactVersion
An artifact version is an object that represents a user-defined unit of related files typically produced by one job and consumed by one or more other jobs.
Property Name | Description |
---|---|
acl |
|
artifactKey |
|
artifactName |
|
artifactVersionId |
|
artifactVersionName |
|
artifactVersionState |
|
buildNumber |
|
createTime |
|
description |
|
groupId |
|
lastModifiedBy |
|
majorMinorPatch |
|
modifyTime |
|
owner |
|
propertySheet |
|
publisherJobId |
|
publisherJobName |
|
publisherJobStepId |
|
qualifier |
|
repositoryName |
|
version |
|
credential
In CloudBees CD/RO, a credential is an object that stores a username and password for later use.
Property Name | Description |
---|---|
acl |
|
createTime |
|
credentialId |
|
credentialName |
|
description |
|
lastModifiedBy |
|
modifyTime |
|
owner |
|
password |
|
projectName |
|
propertySheet |
|
userName |
|
directoryProvider
A directoryProvider is an object containing information about an external directory service (LDAP or ActiveDirectory).
Property Name | Description | ||
---|---|---|---|
acl |
|
||
commonGroupNameAttribute |
|
||
createTime |
|
||
description |
|
||
directoryProviderId |
|
||
domainName |
|
||
emailAttribute |
|
||
enableGroups |
|
||
fullUserNameAttribute |
|
||
groupBase |
|
||
groupMemberAttributes |
|
||
groupMemberFilter |
|
||
groupNameAttribute |
|
||
groupSearchFilter |
|
||
lastModifiedBy |
|
||
managerDn |
|
||
modifyTime |
|
||
owner |
|
||
propertySheet |
|
||
providerIndex |
|
||
providerName |
|
||
providerType |
` string: <ldap|activedirectory>` |
||
realm |
|
||
url |
|
||
userBase |
|
||
userNameAttribute |
|
||
userSearchFilter |
|
||
userSearchSubtree |
|
||
useSSL |
|
emailConfig
An emailConfig is an object that stores information created and used to communicate with the email server.
Property Name | Description |
---|---|
acl |
|
configName |
|
createTime |
|
description |
|
emailConfigId |
|
emailConfigName |
|
lastModifiedBy |
|
mailFrom |
|
mailHost |
|
mailPort |
|
mailProtocol |
|
mailUser |
|
modifyTime |
|
owner |
|
propertySheet |
|
emailNotifier
An emailNotifier is an object that stores information created and used to notify users about various types information, including status.
Property Name | Description |
---|---|
acl |
|
condition |
|
configName |
|
container |
|
containerType |
|
createTime |
|
description |
|
destinations |
|
emailNotifierId |
|
eventType |
|
formattingTemplate |
|
lastModifiedBy |
|
modifyTime |
|
notifierName |
|
owner |
|
propertySheet |
|
formalParameter
A formalParameter
is a parameter expected by a procedure, including its name, a default value, and an indication of whether the parameter is required. Formal parameters are different from "actual parameters"--- formal parameters define the type of parameters a procedure is expecting, and actual parameters provide values to use at run-time.
Property Name | Description |
---|---|
container |
|
containerType |
|
createTime |
|
defaultValue |
|
description |
|
expansionDeferred |
|
formalParameterId |
|
formalParameterName |
|
lastModifiedBy |
|
modifyTime |
|
owner |
|
required |
|
type |
|
gateway
To communicate with a resource, workspace, or artifact repository server in another zone, a gateway must be created. A gateway object contains two resource (agent) machines, for example, GatewayResource1 and GatewayResource2—each configured to communicate with the other. One gateway resource resides in the source zone and the other in the target zone. A gateway is bidirectional and informs the CloudBees CD/RO server that each gateway machine is configured to communicate with its other gateway machine (in another zone).
Property Name | Description |
---|---|
acl |
|
createTime |
|
description |
|
gatewayDisabled |
` boolean: ` If set to 1 (true), the gateway is disabled. |
gatewayId |
|
gatewayName |
|
hostName1 |
|
hostName2 |
` string: The agent host name where Resource2 resides. This host name is used by Resource1 to communicate with Resource2. Do not specify this option is you want to use the host name from Resource2’s definition.` |
lastModifiedBy |
|
modifyTime |
|
owner |
|
port1 |
|
port2 |
|
propertySheet |
|
resourceName1 |
|
resourceName2 |
|
group
This is any group of users known to the CloudBees CD/RO server, including groups defined locally within the server and those groups defined in external repositories such as LDAP or ActiveDirectory.
Property Name | Description |
---|---|
acl |
|
createTime |
|
groupId |
|
groupName |
|
lastModifiedBy |
|
modifyTime |
|
mutable |
|
owner |
|
propertySheet |
|
providerName |
|
job
A job is a CloudBees CD/RO structure associated with invoking a procedure. A new job is created each time a procedure begins to execute. The job keeps track of all data associated with the procedure’s execution, such as the running time of each step and any errors that may occur during the step. CloudBees CD/RO retains job information after the job completes so you can examine what occurred.
Property Name | Description |
---|---|
abortStatus |
|
abortedBy |