com.amazonaws.services.codebuild.model

Class StartBuildRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codebuild.model.StartBuildRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartBuildRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartBuildRequest()

Method Summary

Modifier and Type	Method and Description
StartBuildRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
ProjectArtifacts	getArtifactsOverride() Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
String	getBuildspecOverride() A build spec declaration that overrides, for this build only, the latest one already defined in the build project.
List<EnvironmentVariable>	getEnvironmentVariablesOverride() A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
String	getProjectName() The name of the build project to start running a build.
String	getSourceVersion() A version of the build input to be built, for this build only.
Integer	getTimeoutInMinutesOverride() The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.
int	hashCode()
void	setArtifactsOverride(ProjectArtifacts artifactsOverride) Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
void	setBuildspecOverride(String buildspecOverride) A build spec declaration that overrides, for this build only, the latest one already defined in the build project.
void	setEnvironmentVariablesOverride(Collection<EnvironmentVariable> environmentVariablesOverride) A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
void	setProjectName(String projectName) The name of the build project to start running a build.
void	setSourceVersion(String sourceVersion) A version of the build input to be built, for this build only.
void	setTimeoutInMinutesOverride(Integer timeoutInMinutesOverride) The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.
String	toString() Returns a string representation of this object; useful for testing and debugging.
StartBuildRequest	withArtifactsOverride(ProjectArtifacts artifactsOverride) Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
StartBuildRequest	withBuildspecOverride(String buildspecOverride) A build spec declaration that overrides, for this build only, the latest one already defined in the build project.
StartBuildRequest	withEnvironmentVariablesOverride(Collection<EnvironmentVariable> environmentVariablesOverride) A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
StartBuildRequest	withEnvironmentVariablesOverride(EnvironmentVariable... environmentVariablesOverride) A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
StartBuildRequest	withProjectName(String projectName) The name of the build project to start running a build.
StartBuildRequest	withSourceVersion(String sourceVersion) A version of the build input to be built, for this build only.
StartBuildRequest	withTimeoutInMinutesOverride(Integer timeoutInMinutesOverride) The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartBuildRequest

public StartBuildRequest()

Method Detail

setProjectName

public void setProjectName(String projectName)

The name of the build project to start running a build.

Parameters:

projectName - The name of the build project to start running a build.

getProjectName

public String getProjectName()

The name of the build project to start running a build.

Returns:

The name of the build project to start running a build.

withProjectName

public StartBuildRequest withProjectName(String projectName)

The name of the build project to start running a build.

Parameters:

projectName - The name of the build project to start running a build.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSourceVersion

public void setSourceVersion(String sourceVersion)

A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:

• For AWS CodeCommit: the commit ID to use.

• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.

• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.

• For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.

Parameters:

sourceVersion - A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:

• For AWS CodeCommit: the commit ID to use.

• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.

• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.

• For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.

getSourceVersion

public String getSourceVersion()

A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:

• For AWS CodeCommit: the commit ID to use.

• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.

• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.

• For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.

Returns:

A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:

• For AWS CodeCommit: the commit ID to use.

• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.

• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.

• For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.

withSourceVersion

public StartBuildRequest withSourceVersion(String sourceVersion)

A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:

• For AWS CodeCommit: the commit ID to use.

• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.

• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.

• For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.

Parameters:

sourceVersion - A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:

• For AWS CodeCommit: the commit ID to use.

• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.

• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.

• For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.

Returns:

Returns a reference to this object so that method calls can be chained together.

setArtifactsOverride

public void setArtifactsOverride(ProjectArtifacts artifactsOverride)

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

Parameters:

artifactsOverride - Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

getArtifactsOverride

public ProjectArtifacts getArtifactsOverride()

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

Returns:

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

withArtifactsOverride

public StartBuildRequest withArtifactsOverride(ProjectArtifacts artifactsOverride)

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

Parameters:

artifactsOverride - Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

Returns:

Returns a reference to this object so that method calls can be chained together.

getEnvironmentVariablesOverride

public List<EnvironmentVariable> getEnvironmentVariablesOverride()

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Returns:

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

setEnvironmentVariablesOverride

public void setEnvironmentVariablesOverride(Collection<EnvironmentVariable> environmentVariablesOverride)

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Parameters:

environmentVariablesOverride - A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

withEnvironmentVariablesOverride

public StartBuildRequest withEnvironmentVariablesOverride(EnvironmentVariable... environmentVariablesOverride)

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

NOTE: This method appends the values to the existing list (if any). Use setEnvironmentVariablesOverride(java.util.Collection) or withEnvironmentVariablesOverride(java.util.Collection) if you want to override the existing values.

Parameters:

environmentVariablesOverride - A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Returns:

Returns a reference to this object so that method calls can be chained together.

withEnvironmentVariablesOverride

public StartBuildRequest withEnvironmentVariablesOverride(Collection<EnvironmentVariable> environmentVariablesOverride)

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Parameters:

environmentVariablesOverride - A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBuildspecOverride

public void setBuildspecOverride(String buildspecOverride)

A build spec declaration that overrides, for this build only, the latest one already defined in the build project.

Parameters:

buildspecOverride - A build spec declaration that overrides, for this build only, the latest one already defined in the build project.

getBuildspecOverride

public String getBuildspecOverride()

A build spec declaration that overrides, for this build only, the latest one already defined in the build project.

Returns:

A build spec declaration that overrides, for this build only, the latest one already defined in the build project.

withBuildspecOverride

public StartBuildRequest withBuildspecOverride(String buildspecOverride)

A build spec declaration that overrides, for this build only, the latest one already defined in the build project.

Parameters:

buildspecOverride - A build spec declaration that overrides, for this build only, the latest one already defined in the build project.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTimeoutInMinutesOverride

public void setTimeoutInMinutesOverride(Integer timeoutInMinutesOverride)

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

Parameters:

timeoutInMinutesOverride - The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

getTimeoutInMinutesOverride

public Integer getTimeoutInMinutesOverride()

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

Returns:

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

withTimeoutInMinutesOverride

public StartBuildRequest withTimeoutInMinutesOverride(Integer timeoutInMinutesOverride)

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

Parameters:

timeoutInMinutesOverride - The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartBuildRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()