jetbrains.buildServer.serverSide

Class BuildQueryOptions

java.lang.Object

jetbrains.buildServer.serverSide.BuildQueryOptions

public class BuildQueryOptions
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BuildQueryOptions()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAgentName()
int	getAgentTypeId()
java.lang.String	getBranch()
java.lang.String	getBuildTypeId()
java.util.Set<java.lang.String>	getBuildTypeIds()
User	getOwner()
java.lang.Boolean	getPinStatus()
java.lang.String	getTagName()
User	getTagOwner()
boolean	isIncludeCanceled()
boolean	isIncludePersonal()
boolean	isIncludeRunning()
boolean	isMatchAllBranches()
boolean	isOrderByChanges()
BuildQueryOptions	setAgent(SBuildAgent agent) Set agent to return only builds executed by the specified agent.
BuildQueryOptions	setAgentName(java.lang.String agentName) Set to filter builds by agents with specified name.
BuildQueryOptions	setAgentTypeId(int agentTypeId) Set to filter builds by agent type, see SBuildAgent.getAgentTypeId()
BuildQueryOptions	setBranch(java.lang.String branch) Only return builds with specified branch.
BuildQueryOptions	setBuildTypeId(java.lang.String buildTypeId) Only return builds from the build type with the specified internal id
BuildQueryOptions	setBuildTypeIds(java.util.Collection<java.lang.String> buildTypeIds) Only return builds from build types with the specified internal ids.
BuildQueryOptions	setIncludeCanceled(boolean includeCanceled)
BuildQueryOptions	setIncludePersonal(boolean includePersonal, User owner)
BuildQueryOptions	setIncludeRunning(boolean includeRunning)
BuildQueryOptions	setMatchAllBranches(boolean matchAllBranches)
BuildQueryOptions	setOrderByChanges(boolean orderByChanges)
BuildQueryOptions	setPinStatus(java.lang.Boolean pinStatus) Sets pin status filter.
BuildQueryOptions	setTagName(java.lang.String tagName, User tagOwner) Set tag name to return only builds with specified tag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BuildQueryOptions

public BuildQueryOptions()

Method Detail

setBuildTypeId

@NotNull
public BuildQueryOptions setBuildTypeId(@NotNull
                                                 java.lang.String buildTypeId)

Only return builds from the build type with the specified internal id

Parameters:

buildTypeId - internal id of a build configuration

Returns:

same options

getBuildTypeId

@Nullable
public java.lang.String getBuildTypeId()

setBuildTypeIds

public BuildQueryOptions setBuildTypeIds(@NotNull
                                         java.util.Collection<java.lang.String> buildTypeIds)

Only return builds from build types with the specified internal ids.

Parameters:

buildTypeIds - internal ids of build types

Returns:

same options instance

Since:

2017.2

getBuildTypeIds

@Nullable
public java.util.Set<java.lang.String> getBuildTypeIds()

setBranch

@NotNull
public BuildQueryOptions setBranch(@NotNull
                                            java.lang.String branch)

Only return builds with specified branch. Use Branch.DEFAULT_BRANCH_NAME constant for builds from default branch. By default only builds from default branch are returned (unless setMatchAllBranches(boolean) is set to true).

Parameters:

branch - a particular branch to return builds from

Returns:

same options

getBranch

@Nullable
public java.lang.String getBranch()

setMatchAllBranches

@NotNull
public BuildQueryOptions setMatchAllBranches(boolean matchAllBranches)

isMatchAllBranches

public boolean isMatchAllBranches()

setIncludeRunning

@NotNull
public BuildQueryOptions setIncludeRunning(boolean includeRunning)

isIncludeRunning

public boolean isIncludeRunning()

setIncludeCanceled

@NotNull
public BuildQueryOptions setIncludeCanceled(boolean includeCanceled)

isIncludeCanceled

public boolean isIncludeCanceled()

setIncludePersonal

@NotNull
public BuildQueryOptions setIncludePersonal(boolean includePersonal,
                                                     @Nullable
                                                     User owner)

isIncludePersonal

public boolean isIncludePersonal()

getOwner

@Nullable
public User getOwner()

setOrderByChanges

@NotNull
public BuildQueryOptions setOrderByChanges(boolean orderByChanges)

isOrderByChanges

public boolean isOrderByChanges()

setAgentTypeId

@NotNull
public BuildQueryOptions setAgentTypeId(int agentTypeId)

Set to filter builds by agent type, see SBuildAgent.getAgentTypeId()

Parameters:

agentTypeId - agent type id

Returns:

the same options instance

Since:

2017.2

getAgentTypeId

public int getAgentTypeId()

setAgentName

@NotNull
public BuildQueryOptions setAgentName(@NotNull
                                               java.lang.String agentName)

Set to filter builds by agents with specified name.

Parameters:

agentName - name of an agent

Returns:

the same options instance

Since:

2017.2

getAgentName

@Nullable
public java.lang.String getAgentName()

setAgent

@NotNull
public BuildQueryOptions setAgent(@NotNull
                                           SBuildAgent agent)

Set agent to return only builds executed by the specified agent. Calling this method will reset agent type id and agent name to default values (0 and null correspondingly).

Parameters:

agent - agent

Returns:

the same options instance

setTagName

@NotNull
public BuildQueryOptions setTagName(@NotNull
                                             java.lang.String tagName,
                                             @Nullable
                                             User tagOwner)

Set tag name to return only builds with specified tag.

Parameters:

tagName - name of the tag

tagOwner - owner of a tag, if not null then search is performed by private tags

Returns:

the same options instance

getTagName

@Nullable
public java.lang.String getTagName()

getTagOwner

@Nullable
public User getTagOwner()

setPinStatus

public BuildQueryOptions setPinStatus(java.lang.Boolean pinStatus)

Sets pin status filter.

Parameters:

pinStatus - if true, only pinned builds are returned, if false, only not pinned builds are returned, if null, builds with any pin status are returned

Returns:

the same options instance

Since:

2019.2

getPinStatus

@Nullable
public java.lang.Boolean getPinStatus()