jetbrains.buildServer.agent

Enum BuildFinishedStatus

java.lang.Object

java.lang.Enum<BuildFinishedStatus>

jetbrains.buildServer.agent.BuildFinishedStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BuildFinishedStatus>

public enum BuildFinishedStatus
extends java.lang.Enum<BuildFinishedStatus>

Contains build finish statuses on agent

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINISHED_DETACHED Can be returned by a build step to indicate that the build should continue running even when it finishes on the agent.
FINISHED_FAILED Build failed
FINISHED_SUCCESS Build finished successfully
FINISHED_WITH_PROBLEMS Some build problems were reported Should be returned when runner failed but reported build problem to server
INTERRUPTED Build was interrupted

Method Summary

Modifier and Type	Method and Description
boolean	isFailed() Interrupted build is failed.
boolean	isFinished() Build is finished iff it was not interrupted
static BuildFinishedStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BuildFinishedStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
BuildFinishedStatus	worse(BuildFinishedStatus status) Deprecated. since 2019.2

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INTERRUPTED

public static final BuildFinishedStatus INTERRUPTED

Build was interrupted

FINISHED_SUCCESS

public static final BuildFinishedStatus FINISHED_SUCCESS

Build finished successfully

FINISHED_FAILED

public static final BuildFinishedStatus FINISHED_FAILED

Build failed

FINISHED_WITH_PROBLEMS

public static final BuildFinishedStatus FINISHED_WITH_PROBLEMS

Some build problems were reported Should be returned when runner failed but reported build problem to server

Since:

7.1

FINISHED_DETACHED

public static final BuildFinishedStatus FINISHED_DETACHED

Can be returned by a build step to indicate that the build should continue running even when it finishes on the agent. Can be useful for the cases when step spawned some task in external system and the agent should not wait for it. Instead the task will later report its progress directly to the TeamCity server and will call build finished on the server.

Since:

2019.2

Method Detail

values

public static BuildFinishedStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BuildFinishedStatus c : BuildFinishedStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BuildFinishedStatus valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isFailed

public boolean isFailed()

Interrupted build is failed.

Returns:

true if build is failed.

isFinished

public boolean isFinished()

Build is finished iff it was not interrupted

Returns:

true is build was finished.

worse

public BuildFinishedStatus worse(@Nullable
                                 BuildFinishedStatus status)

Deprecated. since 2019.2

Computes the worst status between this and given

Parameters:

status - to compare with

Returns:

the worst status