com.microsoft.tfs.core.clients.build
Interface IBuildRequest


public interface IBuildRequest


Method Summary
 com.microsoft.tfs.util.GUID getBatchID()
          The batch ID for the request.
 IBuildController getBuildController()
          The build controller on which the requested build should be started.
 java.lang.String getBuildControllerURI()
          The Uri of the build controller on which the requested build should be started.
 IBuildDefinition getBuildDefinition()
          The build definition for which the requested build should be started.
 java.lang.String getBuildDefinitionURI()
          The Uri of the build definition for which the requested build should be started.
 IBuildServer getBuildServer()
          Gets the build server from which this build request was created.
 java.lang.String getCustomGetVersion()
          If GetOption is Custom, the version spec for which sources should be retrieved for the requested build.
 java.lang.String getDropLocation()
          The location to drop the outputs of the requested build.
 java.lang.String getGatedCheckInTicket()
          Optional ticket issued by the server for gated check-in submissions.
 GetOption getGetOption()
          Specifies how sources should be retrieved for the requested build - either LatestOnQueue - get the latest sources as of the time the build was queued, LatestOnBuild - get the latest sources as of the time the build starts, or Custom - If you set this to custom, you must specify a valid VersionSpec in the CustomGetVersion field.
 int getMaxQueuePosition()
          The maximum position in the queue for the requested build at queue time.
 QueuePriority getPriority()
          The priority for the requested build.
 java.lang.String getProcessParameters()
          The process parameters used to initialize the build process.
 BuildReason getReason()
          The reason to be used for the build request.
 java.lang.String getRequestedFor()
          The user for whom the build is being requested.
 java.lang.String getShelvesetName()
          Optional shelveset to be built.
 boolean isPostponed()
          Determines whether or not the request will be submitted with a postponed status.
 void setBatchID(com.microsoft.tfs.util.GUID value)
           
 void setBuildController(IBuildController value)
           
 void setBuildDefinitionURI(java.lang.String value)
           
 void setCustomGetVersion(java.lang.String value)
           
 void setDropLocation(java.lang.String value)
           
 void setGatedCheckInTicket(java.lang.String value)
           
 void setGetOption(GetOption value)
           
 void setMaxQueuePosition(int value)
           
 void setPostponed(boolean value)
           
 void setPriority(QueuePriority value)
           
 void setProcessParameters(java.lang.String value)
           
 void setReason(BuildReason value)
           
 void setRequestedFor(java.lang.String value)
           
 void setShelvesetName(java.lang.String value)
           
 

Method Detail

getBatchID

com.microsoft.tfs.util.GUID getBatchID()
The batch ID for the request.

Returns:

setBatchID

void setBatchID(com.microsoft.tfs.util.GUID value)

getBuildController

IBuildController getBuildController()
The build controller on which the requested build should be started.

Returns:

setBuildController

void setBuildController(IBuildController value)

getBuildControllerURI

java.lang.String getBuildControllerURI()
The Uri of the build controller on which the requested build should be started.

Returns:

getBuildDefinition

IBuildDefinition getBuildDefinition()
The build definition for which the requested build should be started. Provides default values for BuildController and DropLocation.

Returns:

getBuildDefinitionURI

java.lang.String getBuildDefinitionURI()
The Uri of the build definition for which the requested build should be started.

Returns:

setBuildDefinitionURI

void setBuildDefinitionURI(java.lang.String value)

getCustomGetVersion

java.lang.String getCustomGetVersion()
If GetOption is Custom, the version spec for which sources should be retrieved for the requested build.

Returns:

setCustomGetVersion

void setCustomGetVersion(java.lang.String value)

getDropLocation

java.lang.String getDropLocation()
The location to drop the outputs of the requested build.

Returns:

setDropLocation

void setDropLocation(java.lang.String value)

getGetOption

GetOption getGetOption()
Specifies how sources should be retrieved for the requested build - either LatestOnQueue - get the latest sources as of the time the build was queued, LatestOnBuild - get the latest sources as of the time the build starts, or Custom - If you set this to custom, you must specify a valid VersionSpec in the CustomGetVersion field.

Returns:

setGetOption

void setGetOption(GetOption value)

getMaxQueuePosition

int getMaxQueuePosition()
The maximum position in the queue for the requested build at queue time. If the build request falls below this position in a call to QueueBuild an exception will be thrown.

Returns:

setMaxQueuePosition

void setMaxQueuePosition(int value)

isPostponed

boolean isPostponed()
Determines whether or not the request will be submitted with a postponed status.

Returns:

setPostponed

void setPostponed(boolean value)

getPriority

QueuePriority getPriority()
The priority for the requested build.

Returns:

setPriority

void setPriority(QueuePriority value)

getProcessParameters

java.lang.String getProcessParameters()
The process parameters used to initialize the build process.

Returns:

setProcessParameters

void setProcessParameters(java.lang.String value)

getRequestedFor

java.lang.String getRequestedFor()
The user for whom the build is being requested.

Returns:

setRequestedFor

void setRequestedFor(java.lang.String value)

getReason

BuildReason getReason()
The reason to be used for the build request.

Returns:

setReason

void setReason(BuildReason value)

getShelvesetName

java.lang.String getShelvesetName()
Optional shelveset to be built.

Returns:

setShelvesetName

void setShelvesetName(java.lang.String value)

getGatedCheckInTicket

java.lang.String getGatedCheckInTicket()
Optional ticket issued by the server for gated check-in submissions. When a check-in is rejected due to Gated Check-in a GatedCheckinException is thrown. The gated check-in ticket is available on the exception and should be used when submitting the build request to the build system. Setting this property from the exception allows a rejected check-in to be queued by a user who does not have the appropriate permissions to perform the action under normal circumstances.

Returns:

setGatedCheckInTicket

void setGatedCheckInTicket(java.lang.String value)

getBuildServer

IBuildServer getBuildServer()
Gets the build server from which this build request was created.

Returns:


© 2015 Microsoft. All rights reserved.