Build Management API reference

buildClassName

Name for the build class.

tagDefinition

Format string that defines the resultant build name. The default is default_%GC%_%DATE%. This string generally consists of a generic build name appended with build-specific data that you construct from the following variables:

GC —Globally unique number (Global Counter)

LC —Number unique to the build class (Local Counter; the build serial number within the class)

BUILD_CLASS —User-defined build class name

BUILD_CLASS_ID —System-generated number that the Cluster Manager uses to identify each class

USER_NAME —Name of the user who invoked eMake

MACHINE_NAME —Name of the machine where eMake was invoked

USER_BUILD_LABEL —Label specified at the eMake command line. For example, --emake-build-label=my_build

BUILD_OS_ID —Operating system ID under which the build was invoked (0 = undefined, 1 = Windows, and 3 = Linux)

DATE —Build start date and time using variables Y, y, m, d, H, M, and S (for example, 2005-01-18 10:14:32 is 20050118101432 )

Y —Year at build start time ( YYYY )

y —Year at build start time ( YY )

m —Sequential month number at build start time ( 1-12 )

d —Sequential day of month at build start time ( 1-31 )

H —Hour of the day at build start time ( 0-23 )

M —Minutes at build start time ( 0-59 )

S —Seconds at build start time ( 0-60 )

a —Abbreviated day of week at build start time ( WED )

A —Full name day of week at build start time ( Wednesday )

b —Abbreviated month name at build start time ( AUG )

B —Full month name at build start time ( August )

c —Build start date and time using the variables A, B, d, H, M, S, and Y (for example, 2005-01-18 10:14:32 means 18/01/05 10:14:32 )

For information about constructing tag definitions, see Using Build Classes.

annotationLevels

Comma-separated list of values that indicates which levels of information to include in the annotation file. The possible values are basic, env, history, file, lookup, waiting, or registry (Windows only). An annotation file is not created until you specify at least one annotation level.

Basic annotation includes annotation for the JobCache feature.

(For more information see Job Caching.

maxAgents

Maximum number of agents that can be assigned to this build. The default is 64.

minAgents

Minimum number of agents required for this build to run. The default is 2.

platform

OS being used or supported. The possible values are Windows or Linux. If an OS is specified for a build class, builds from other operating systems cannot affiliate themselves with this class. The default is that no platforms are specified.

priority

Priority for builds in this class. You can use one of three levels of priority: high, normal, and low. The default is 120 (middle of the normal priority range). The priority can be adjusted up or down by 1-10 to “boost” the priority to give certain classes preference over other builds of the same priority level. Higher boost values mean greater preference.

The value must be a number in one of the following three ranges:

annoUpload

Specifies whether to upload the annotation file to the Cluster Manager. The possible values are Y, 1, or true (upload) or N, 0, or false (do not upload). The default is N.

jobcacheAllowed

Specifies whether the JobCache feature is allowed for this build class. The possible values are Y, 1, or true (allow) or N, 0, or false (do not allow). The default is N, except for the default build class and for build classes that exist when you upgrade to CloudBees Build Acceleration 8.0.

For more information about JobCache, see Job Caching.

resourceRequest

Name of an existing resource. This requests a particular type of agent from the cloud provider.

buildClassId

A unique number assigned by the Cluster Manager for each build class. Use getBuildClasses to retrieve a list of build class IDs.

text

The comment text.

buildId

A unique number assigned by the Cluster Manager for each build. Use the getBuilds command to retrieve a list of build IDs.

text

The comment text.

buildId

A unique number assigned by the Cluster Manager for each build. Use the getBuilds command to retrieve a list of build IDs.

buildClassId

A unique number assigned by the Cluster Manager for each build class. Use the getBuildClasses command to retrieve a list of build class IDs.

filter

A SQL query used to limit the result set. See the possible values below. For a list of possible SQL values, see the getBuildClasses command.

buildClassId

A unique number assigned by the Cluster Manager for each build class.

commentId

The unique key that identifies a comment.

buildId

A unique number assigned by the Cluster Manager for each build.

commentId

The unique key that identifies a comment. Use the getBuildComments command to retrieve a list of comment IDs.

filter

SQL query used to limit the result set. For a list of possible SQL values, see the getBuilds command.

buildId

A unique number assigned by the Cluster Manager for each build. Use the getBuilds command to retrieve a list of build IDs.

allocatedAgents buildClassId buildClassName buildId buildLogDir buildName commandLine conflicts cwd duration effectiveAgentAlloc emakeVersion historyExists historyFile hostName

ipAddress jobCount lastRequestTime maxAgents minAgents osUserName platform priority resourceRequest result requestedAgents startTime userLabel userName waitTime

filter

A SQL query used to limit the result set. See the possible values below.

maxResults

The maximum number of elements to run from a query.

firstResult

The starting index for the query result set.

order

A SQL order by clause. Used to specify ordering for the query result set.

profile

Can be details or info. This is the level of detail to return from a query; details gets all information and info gets a reduced information set.

allocatedAgents

The number of currently assigned agents for this build. SQL query name for --filter and --order: N/A

availableResults

This is a count of ’max’ or ’first’ results if --maxResults or --firstResult is specified. SQL query name for --filter and --order: N/A

buildClassId

A unique number assigned by the Cluster Manager for each build class. SQL query name for --filter and --order: build_class_id

buildClassName

A name assigned by the user for the build class. SQL query name for --filter and --order: build_class_name

buildId

A unique number assigned by the Cluster Manager for each build. SQL query name for --filter and --order: id

buildLogDir

The directory containing uploaded build logs. SQL query name for --filter and --order: N/A

buildName

The build name that is the expanded build class tag. SQL query name for --filter and --order: build_name

commandLine

The original command-line invocation of eMake. SQL query name for --filter and --order: command_line

conflicts

The number of conflicts in the build. SQL query name for --filter and --order: conflicts

cwd

The current working directory where eMake was invoked. SQL query name for --filter and --order: cwd

duration

The number of milli-seconds the build has been running.

effectiveAgentAlloc

The effective agent allocation percentage. 100% means eMake had all the hosts it needed all the time, while a lesser percentage means eMake had the hosts it needed for that percent of time.

emakeVersion

The eMake version used for this build. SQL query name for --filter and --order: emake_version

historyExists

True means the history file existed and was used by the build. SQL query name for --filter and --order: history_exists

historyFile

The name of the eMake history file. SQL query name for --filter and --order: history_file

hostName

The name of the machine where eMake was invoked. SQL query name for --filter and --order: host_name

ipAddress

The IP address of the machine where eMake was invoked. SQL query name for --filter and --order: ip_address

jobCount

The total number of jobs that ran for the build.

lastRequestTime

The last time eMake requested agents for this build. SQL query name for --filter and --order: N/A

maxAgents

The maximum number of agents to request for this build. SQL query name for --filter and --order: max_agents

minAgents

The minimum number of agents required for this build to run. SQL query name for --filter and --order: min_agents

osUserName

The OS-level name for the user who started eMake. SQL query name for --filter and --order: os_user_name

platform

The operating system being used/supported. If an OS is specified for a build class, builds from other operating systems cannot affiliate themselves with this class. SQL query name for --filter and --order: platform

priority

The build priority level. When assigning resources, an optional priority boost value can be selected to give a build class preference over other builds of the same priority level. Higher boost values correspond to greater preference. SQL query name for --filter and --order: priority

resourceRequest

A request to the cloud provider for a particular type of agent. SQL query name for --filter and --order: resource_request

result

The build result code. -1 means the build is still running, 0-254 are actual exit codes, 256 means the build timed out, and 257 means the build was stopped. SQL query name for --filter and --order: result

requestedAgents

The number of agents eMake requested. SQL query name for --filter and --order: N/A

startTime

The time the build was started. SQL query name for --filter and --order: start_time

userLabel

The user-supplied label (via the eMake command-line), attached to the build. SQL query name for --filter and --order: user_label

userName

The unique name of the user. SQL query name for --filter and --order: user_name

waitTime

The number of seconds eMake was stalled because it had to wait for agents.

buildId()

A unique number assigned by the Cluster Manager for each build. Use the getBuilds command to retrieve a list of build IDs.

commentId

The unique key that identifies a comment.

commentId

The unique key that identifies a comment.

createTime

The time when the item was created.

lastModifiedBy

The user who last modified the item.

modifyTime

The time when the item was last modified.

text

The text of the item.

buildClassId

A unique number assigned by the Cluster Manager for each build class. Use the getBuildClasses command to retrieve a list of build class IDs.

filter

A SQL query used to limit the result set. See the possible values below.

maxResults

The maximum number of elements to run from a query.

firstResult

The starting index for the query result set.

order

SQL order by clause. Used to specify ordering for the query result set.

profile

Can be details or info. This is the level of detail to return from a query; details gets all information and info gets a reduced information set.

annotationLevels

Annotation choices to include in the annotation file. Possible values are basic, history, file, lookup, and waiting. SQL query name for --filter and --order: annotation_levels

annoUpload

If set to true, the annotation file is uploaded to Cluster Manager. SQL query name for --filter and --order: anno_upload

availableResults

This is a count of ’max’ or ’first’ results if --maxResults or --firstResult is specified. SQL query name for --filter and --order: N/A

buildClassId

A unique number assigned by the Cluster Manager for each build class. SQL query name for --filter and --order: id

buildClassName

A name assigned by the user for the build class. SQL query name for --filter and --order: build_class_name

defaultClass

If set, this is the default build class and cannot be deleted. SQL query name for --filter and --order: default_class

maxAgents

The maximum number of agents to request for this build. SQL query name for --filter and --order: max_agents

minAgents

The minimum number of agents required for this build to run. SQL query name for --filter and --order: min_agents

notifyOnBuildEnd

If set to true, the currently logged-in user will receive an email when the build is finished. SQL query name for --filter and --order: notify_on_build_end

platform

The operating system being used/supported. If an OS is specified for a build class, builds from other operating systems cannot affiliate themselves with this class. SQL query name for --filter and --order: platform

priority

The build priority level. When assigning resources, an optional priority boost value can be selected to give a build class preference over other builds of the same priority level. Higher boost values correspond to greater preference. SQL query name for --filter and --order: priority

resourceRequest

A request to the cloud provider for a particular type of agent. resource_request

tagDefinition

A format string that defines the resulting build name. SQL query name for --filter and --order: tag_definition

commentId

The unique key that identifies a comment.

commentId

The unique key that identifies a comment.

createTime

The time when the item was created.

lastModifiedBy

The user who last modified the item.

modifyTime

The time when the item was last modified.

text

The text of the item.

groupBy

Can be hostName, ipAddress, or userName.

filter

A SQL query used to limit the result set. See the possible values below.

order

A SQL order by clause. Used to specify ordering for the query result set.

duration

The total number of milli-seconds of all builds, filtered by the value specified in the ` groupBy ` argument. SQL query name for --filter and --order: N/A duration

entryName

The value specified in the groupBy ` argument. If `groupBy ` is "userName", the entry name is the user name. SQL query name for `--filter and --order: N/A

umOfBuilds

The number of builds. SQL query name for --filter and --order: N/A

waitTime

The number of seconds eMake was stalled because it had to wait for agents. SQL query name for --filter and --order: wait_time

workload

The total number of seconds used by the agents for all of the filtered builds. SQL query name for --filter and --order: workload

<metricType>

Key name of a metric. For example, ConcurrentBuilds. For a list of the available metrics, use the getMetricTypes command and look for the values of the <key> elements in the output.

buildId

A unique number assigned by the Cluster Manager for each build.

priority

Can be Low or Normal, but not High.

buildClassId

Unique number assigned by the Cluster Manager for the build class. You can use the getBuildClasses command to retrieve a list of build class IDs.

buildClassName

User-defined name of the build class.

tagDefinition

Format string that defines the resultant build name. The default is default_%GC%_%DATE%. This string generally consists of a generic build name appended with build-specific data that you construct from the following variables:

GC —Globally unique number (Global Counter)

LC —Number unique to the build class (Local Counter; the build serial number within the class)

BUILD_CLASS —User-defined build class name

BUILD_CLASS_ID —System-generated number that the Cluster Manager uses to identify each class

USER_NAME —Name of the user who invoked eMake

MACHINE_NAME —Name of the machine where eMake was invoked

USER_BUILD_LABEL —Label specified at the eMake command line. For example, --emake-build-label=my_build

BUILD_OS_ID —Operating system ID under which the build was invoked (0 = undefined, 1 = Windows and 3 = Linux)

DATE —Build start date and time using variables Y, y, m, d, H, M, and S (for example, 2005-01-18 10:14:32 is 20050118101432 )

Y —Year at build start time ( YYYY )

y —Year at build start time ( YY )

m —Sequential month number at build start time ( 1-12 )

d —Sequential day of month at build start time ( 1-31 )

H —Hour of the day at build start time ( 0-23 )

M —Minutes at build start time ( 0-59 )

S —Seconds at build start time ( 0-60 )

a —Abbreviated day of week at build start time ( WED )

A —Full name day of week at build start time ( Wednesday )

b —Abbreviated month name at build start time ( AUG )

B —Full month name at build start time ( August )

c —Build start date and time using the variables A, B, d, H, M, S, and Y (for example, 2005-01-18 10:14:32 means 18/01/05 10:14:32 )

For information about constructing tag definitions, see Using Build Classes - Tag Definitions.

annotationLevels

Comma-separated list of values that indicates which levels of information to include in the annotation file. The possible values are basic, env, history, file, lookup, waiting, or registry (Windows only). An annotation file is not created until you specify at least one annotation level.

Basic annotation includes annotation for the JobCache feature.

For more information about JobCache, see Job Caching.

maxAgents

Maximum number of agents that can be assigned to this build. The default is 64.

minAgents

Minimum number of agents required for this build to run. The default is 2.

platform

OS being used or supported. The possible values are Windows or Linux. If an OS is specified for a build class, builds from other operating systems cannot affiliate themselves with this class. The default is that no platforms are specified.

priority

Priority for builds in this class. You can use one of three levels of priority: high, normal, and low. The default is 120 (middle of the normal priority range). The priority can be adjusted up or down by 1-10 to “boost” the priority to give certain classes preference over other builds of the same priority level. Higher boost values mean greater preference.

The value must be a number in one of the following three ranges:

annoUpload

Specifies whether to upload the annotation file to the Cluster Manager. The possible values are Y, 1, or true (upload) or N, 0, or false (do not upload). The default is N.

jobcacheAllowed

Specifies whether the JobCache feature is allowed for this build class. The possible values are Y, 1, or true (allow) or N, 0, or false (do not allow). The default is N, except for the default build class and for build classes that exist when you upgrade to CloudBees Build Acceleration 8.0.

For more information about JobCache, see Job Caching.

resourceRequest

Name of an existing resource. This requests a particular type of agent from the cloud provider.

buildClassId

A unique number assigned by the Cluster Manager that identifies each build class.

commentId

A unique key that identifies a comment.

text

The comment text.

buildId

A unique number assigned by the Cluster Manager for each build.

commentId

The unique key that identifies a comment. Use the getBuildComments command to retrieve a list of comment IDs.

text

The text of the item.

databaseName

The database instance name.

databaseType

The database type. Can be mariadb, mysql, oracle, or sqlserver.

hostName

Machine name where the database is installed.

port

Database port number.

userName

Unique name of the user that is used to access the database.

password

Secret value used to identify an account for a particular user.

buildId

A unique number assigned by the Cluster Manager for each build. Use the getBuilds command to retrieve a list of build IDs.