com.openshift.internal.restclient.capability.resources

Class BuildTrigger

java.lang.Object

com.openshift.internal.restclient.capability.resources.BuildTrigger

All Implemented Interfaces:

ICapability, IBuildTriggerable

public class BuildTrigger
extends Object
implements IBuildTriggerable

Constructor Summary

Constructors

Constructor and Description
BuildTrigger(IBuildConfig buildConfig, IClient client)
BuildTrigger(IBuild build, IClient client)

Method Summary

Modifier and Type	Method and Description
void	addBuildCause(String cause) Add a human readable short explanation of why this build request was issued
List<String>	getBuildCauses() Get the list of human readable short explanations of why this build request was issued
String	getCommitId() Get the commit level for the SCM extraction of the source code the build operates against
String	getName() Well known name of the capability
boolean	isSupported() Allow the implementation of the capability to determine if it is supported on the OpenShift server.
void	setCommitId(String commitId) Set the commit level for the SCM extraction of the source code the build operates against
void	setEnvironmentVariable(String name, String value) Sets an environment variable for this build request
IBuild	trigger() Trigger a build based on a build config
IBuild	trigger(String commitId) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildTrigger

public BuildTrigger(IBuildConfig buildConfig,
                    IClient client)

BuildTrigger

public BuildTrigger(IBuild build,
                    IClient client)

Method Detail

isSupported

public boolean isSupported()

Description copied from interface: ICapability

Allow the implementation of the capability to determine if it is supported on the OpenShift server. Implementations should return false if they can not

Specified by:

isSupported in interface ICapability

Returns:

true if the capability exists

getName

public String getName()

Description copied from interface: ICapability

Well known name of the capability

Specified by:

getName in interface ICapability

trigger

public IBuild trigger()

Description copied from interface: IBuildTriggerable

Trigger a build based on a build config

Specified by:

trigger in interface IBuildTriggerable

Returns:

The build that was triggered

trigger

@Deprecated
public IBuild trigger(String commitId)

Deprecated.

Description copied from interface: IBuildTriggerable

Trigger a build with the given source level commit id

Specified by:

trigger in interface IBuildTriggerable

Returns:

The build that was triggered

setCommitId

public void setCommitId(String commitId)

Description copied from interface: IBuildTriggerable

Set the commit level for the SCM extraction of the source code the build operates against

Specified by:

setCommitId in interface IBuildTriggerable

Parameters:

commitId - the specific hexadecimal commit ID associated with a SCM log level

getCommitId

public String getCommitId()

Description copied from interface: IBuildTriggerable

Get the commit level for the SCM extraction of the source code the build operates against

Specified by:

getCommitId in interface IBuildTriggerable

Returns:

the specific hexadecimal commit ID associated with a SCM log level

addBuildCause

public void addBuildCause(String cause)

Description copied from interface: IBuildTriggerable

Add a human readable short explanation of why this build request was issued

Specified by:

addBuildCause in interface IBuildTriggerable

Parameters:

cause - the description to add to the list of causes for this request

getBuildCauses

public List<String> getBuildCauses()

Description copied from interface: IBuildTriggerable

Get the list of human readable short explanations of why this build request was issued

Specified by:

getBuildCauses in interface IBuildTriggerable

Returns:

list of reasons for the build

setEnvironmentVariable

public void setEnvironmentVariable(String name,
                                   String value)

Description copied from interface: IBuildTriggerable

Sets an environment variable for this build request

Specified by:

setEnvironmentVariable in interface IBuildTriggerable

Parameters:

name - The name of the environment variable

value - The value of the environment variable