|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.buildforge.services.client.dbo.Result
public class Result
This class represents the runtime result of an executed Step
of a Project
.
In general, only the Build Forge engine creates these objects.
Field Summary | |
---|---|
static java.lang.Class<Result> |
CLASS
|
Constructor Summary | |
---|---|
Result(APIClientConnection conn)
In the general course of events, only the Build Forge engine will call this,and not standard API clients. |
Method Summary | |
---|---|
static java.util.List<Result> |
findByBuild(APIClientConnection conn,
int buildId)
Retrieves all Results by Build . |
static java.util.List<Result> |
findByBuild(APIClientConnection conn,
int buildId,
boolean getCmd,
boolean getEnv)
Retrieves all Results |
boolean |
getAbsolute()
Returns whether the Step 's path was relative to the Server 's path
(true ) or to the Project 's (false ). |
boolean |
getBroadcast()
Returns true |
int |
getBuildId()
Returns the identifer of the build |
int |
getCaller()
This returns the same value as getOwner() if this step was inlined by a
threaded step, and 0 otherwise. |
int |
getChainedBuildId()
Returns the build id of the chain that was launched according to the step's pass or fail state. |
int |
getChainId()
Returns the Project identifier that was chained inline from this step's
execution, or 0 if no Project was assigned as an inline chain. |
java.lang.String |
getCommandText()
Returns the literal text of the command that was executed |
java.lang.String |
getDescription()
Returns the name of the Step whose Result this is |
java.lang.String |
getDirectory()
Returns the working directory used by this step |
int |
getDuration()
Returns the elapsed time of Step execution, in seconds |
int |
getEnvironmentGroupId()
Returns the identifier of the Environment used during this Step 's execution |
java.lang.String |
getEnvironmentText()
Returns the literal environment used for Step execution. |
int |
getFailChainId()
Returns the identifier of the Project to chain execution to if this step fails. |
java.lang.String |
getFailNotify()
Returns the name of the notification group to notify in the case of failure |
boolean |
getFailWait()
Returns whether or not execution should wait for the fail chain to complete before continuing |
int |
getFilterSetId()
Returns the identifier of the Filter used in association with this Step 's execution |
int |
getFinish()
Returns the timestamp of when execution completed, in seconds since epoch |
ResultDBO.StepFlag |
getFlag()
Returns the step control flag used for pausing, cancelling, etc. |
ResultDBO.Floating |
getFloating()
Returns the floating status flag used in conjunction with project stickiness |
int |
getLevel()
Returns the security level associated with this Result |
java.util.List<Log> |
getLogs()
Returns the log output generated by the this execution |
StepDBO.OnFail |
getOnFail()
Returns whether this Step was step to stop or continue on failure |
int |
getOriginalStepId()
Returns the identifer of the Step that was the original Step definition
within its project. |
int |
getOwner()
Used by inline chains. |
int |
getPassChainId()
Returns the identifier of the Project to chain execution to if this step succeeds. |
java.lang.String |
getPassNotify()
Returns the name of the notification group to notify in the case of success |
boolean |
getPassWait()
Returns whether or not execution should wait for the pass chain to complete before continuing |
int |
getProjectId()
Returns the identifier of the Project to which this Result is associated |
java.lang.String |
getResource()
Initially, this is set from the Step 's resource field. |
ResultDBO.StepResult |
getResult()
Returns the final outcome of execution: pass, fail, warn, etc. |
int |
getResultStepId()
The build-wide, unique, and ordinal identifer for this Result. |
java.lang.String |
getServer()
Returns the name of the Server that was finally chosen to
execute the step on. |
int |
getStartTimestamp()
Returns the timestamp of the beginning of execution in seconds since the epoch |
StepDBO.Threaded |
getThreaded()
Returns how, if at all, this Result was parallelized during execution |
int |
getTimeout()
Return the amount of time, in seconds, that was allowed for execution before forcible termination. |
java.lang.String |
getUid()
The system-wide unique identifier for this Result |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.Class<Result> CLASS
Constructor Detail |
---|
public Result(APIClientConnection conn)
conn
- Method Detail |
---|
public static java.util.List<Result> findByBuild(APIClientConnection conn, int buildId) throws java.io.IOException, ServiceException
Build
. The returns Result objects will
have their command text populated, but not their environments.
See findByBuild(APIClientConnection, int, boolean, boolean)
to
override these defaults.
conn
- buildId
- The build identifier
java.io.IOException
ServiceException
public static java.util.List<Result> findByBuild(APIClientConnection conn, int buildId, boolean getCmd, boolean getEnv) throws java.io.IOException, ServiceException
conn
- buildId
- The build identifiergetCmd
- Whether or not to also return the command textgetEnv
- Whether or not to also return the contents of the environment
java.io.IOException
ServiceException
public boolean getAbsolute()
Step
's path was relative to the Server
's path
(true
) or to the Project
's (false
).
public boolean getBroadcast()
true if a server was a member of a pool, and the step was broadcast
to all of the servers in the pool. This is accomplished by creating a results record for
this step for each server in the pool as if they had been explicitly specified as steps
in the original project. The 'real' step identifier may be retrieved via
getOriginalStepId()
.
public int getBuildId()
public int getCaller()
getOwner()
if this step was inlined by a
threaded step, and 0 otherwise. It is needed for the proper implementation of
threadblocks in combination with inlined projects.
public int getChainedBuildId()
ResultDBO.StepResult.PASSED
or
ResultDBO.StepResult.FILTWARN
) or failing (for ResultDBO.StepResult.FAILED
or
ResultDBO.StepResult.FAILWARN
). Accordingly, either the
Pass Chain Identifier
or the
Fail Chain Identifier
is checked as
appropriate for a valid Project
identifier. If one is found, then
a build of that project is started, and its build id is stored in this
field. The value is negated for fail chains.
public int getChainId()
Project
identifier that was chained inline from this step's
execution, or 0 if no Project
was assigned as an inline chain.
public java.lang.String getCommandText()
public java.lang.String getDescription()
Step
whose Result this is
public java.lang.String getDirectory()
public int getDuration()
Step
execution, in seconds
public int getEnvironmentGroupId()
Environment
used during this Step
's execution
public java.lang.String getEnvironmentText()
Step
execution. This field may or
may not be populated, depending on how this Result was loaded.
See findByBuild(APIClientConnection, int, boolean, boolean)
public int getFailChainId()
Project
to chain execution to if this step fails.
public java.lang.String getFailNotify()
public boolean getFailWait()
public int getFilterSetId()
Filter
used in association with this Step
's execution
public int getFinish()
public ResultDBO.StepFlag getFlag()
Step
.
public ResultDBO.Floating getFloating()
public int getLevel()
public java.util.List<Log> getLogs() throws java.io.IOException, ServiceException
java.io.IOException
ServiceException
public StepDBO.OnFail getOnFail()
Step
was step to stop or continue on failure
public int getOriginalStepId()
Step
that was the original Step definition
within its project. For .load-generated steps, this is set to 0.
public int getOwner()
Step
identifier of the
Result that inlined this step, or 0 if that's not how this Result
came to exist.
public int getPassChainId()
Project
to chain execution to if this step succeeds.
public java.lang.String getPassNotify()
public boolean getPassWait()
public int getProjectId()
Project
to which this Result is associated
public java.lang.String getResource()
Step
's resource field. This is the workspace
for selecting the server on which to run the step. It is originally blank unless the
Step has a Server
explicitly specified for it. This also affects the value of
getFloating()
, the workspace for the implementation of the sticky flag, as a
Server that is explicitly specified will not be changed. However, if this specifies a
Server for which pooling is active, then the Step may be run on any Server in that pool.
public ResultDBO.StepResult getResult()
public int getResultStepId()
public java.lang.String getServer()
Server
that was finally chosen to
execute the step on. It is also the workspace for things like the
sticky flag and .bset server that try to change the server at build time.
public int getStartTimestamp()
public StepDBO.Threaded getThreaded()
public int getTimeout()
public java.lang.String getUid()
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |