Package com.circleci.client.v2.model

Class TriggerPipelineParameters

java.lang.Object

com.circleci.client.v2.model.TriggerPipelineParameters

public class TriggerPipelineParameters
extends Object

The information you can supply when triggering a pipeline.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_BRANCH
static String	JSON_PROPERTY_PARAMETERS
static String	JSON_PROPERTY_TAG

Constructor Summary

Constructors

Constructor	Description
TriggerPipelineParameters()

Method Summary

Modifier and Type	Method	Description
TriggerPipelineParameters	branch(String branch)
boolean	equals(Object o)
String	getBranch()	The branch where the pipeline ran.
Object	getParameters()	An object containing pipeline parameters and their values.
String	getTag()	The tag used by the pipeline.
int	hashCode()
TriggerPipelineParameters	parameters(Object parameters)
void	setBranch(String branch)
void	setParameters(Object parameters)
void	setTag(String tag)
TriggerPipelineParameters	tag(String tag)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_BRANCH

public static final String JSON_PROPERTY_BRANCH

See Also:

Constant Field Values

JSON_PROPERTY_TAG

public static final String JSON_PROPERTY_TAG

See Also:

Constant Field Values

JSON_PROPERTY_PARAMETERS

public static final String JSON_PROPERTY_PARAMETERS

See Also:

Constant Field Values

Constructor Detail

TriggerPipelineParameters

public TriggerPipelineParameters()

Method Detail

branch

public TriggerPipelineParameters branch(String branch)

getBranch

@Nullable
public String getBranch()

The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive.

Returns:

branch

setBranch

public void setBranch(String branch)

tag

public TriggerPipelineParameters tag(String tag)

getTag

@Nullable
public String getTag()

The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive.

Returns:

tag

setTag

public void setTag(String tag)

parameters

public TriggerPipelineParameters parameters(Object parameters)

getParameters

@Nullable
public Object getParameters()

An object containing pipeline parameters and their values.

Returns:

parameters

setParameters

public void setParameters(Object parameters)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object