@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Build extends Object implements Serializable, Cloneable, StructuredPojo
Information about a build.
Constructor and Description |
---|
Build() |
Modifier and Type | Method and Description |
---|---|
Build |
clone() |
boolean |
equals(Object obj) |
String |
getArn()
The Amazon Resource Name (ARN) of the build.
|
BuildArtifacts |
getArtifacts()
Information about the output artifacts for the build.
|
String |
getBuildBatchArn()
The ARN of the batch build that this build is a member of, if applicable.
|
Boolean |
getBuildComplete()
Whether the build is complete.
|
Long |
getBuildNumber()
The number of the build.
|
String |
getBuildStatus()
The current status of the build.
|
ProjectCache |
getCache()
Information about the cache for the build.
|
String |
getCurrentPhase()
The current build phase.
|
DebugSession |
getDebugSession()
Contains information about the debug session for this build.
|
String |
getEncryptionKey()
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
|
Date |
getEndTime()
When the build process ended, expressed in Unix time format.
|
ProjectEnvironment |
getEnvironment()
Information about the build environment for this build.
|
List<ExportedEnvironmentVariable> |
getExportedEnvironmentVariables()
A list of exported environment variables for this build.
|
List<ProjectFileSystemLocation> |
getFileSystemLocations()
An array of
ProjectFileSystemLocation objects for a CodeBuild build project. |
String |
getId()
The unique ID for the build.
|
String |
getInitiator()
The entity that started the build.
|
LogsLocation |
getLogs()
Information about the build's logs in CloudWatch Logs.
|
NetworkInterface |
getNetworkInterface()
Describes a network interface.
|
List<BuildPhase> |
getPhases()
Information about all previous build phases that are complete and information about any current build phase that
is not yet complete.
|
String |
getProjectName()
The name of the CodeBuild project.
|
Integer |
getQueuedTimeoutInMinutes()
The number of minutes a build is allowed to be queued before it times out.
|
List<String> |
getReportArns()
An array of the ARNs associated with this build's reports.
|
String |
getResolvedSourceVersion()
An identifier for the version of this build's source code.
|
List<BuildArtifacts> |
getSecondaryArtifacts()
An array of
ProjectArtifacts objects. |
List<ProjectSource> |
getSecondarySources()
An array of
ProjectSource objects. |
List<ProjectSourceVersion> |
getSecondarySourceVersions()
An array of
ProjectSourceVersion objects. |
String |
getServiceRole()
The name of a service role used for this build.
|
ProjectSource |
getSource()
Information about the source code to be built.
|
String |
getSourceVersion()
Any version identifier for the version of the source code to be built.
|
Date |
getStartTime()
When the build process started, expressed in Unix time format.
|
Integer |
getTimeoutInMinutes()
How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.
|
VpcConfig |
getVpcConfig()
If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC
ID and the list of security group IDs and subnet IDs.
|
int |
hashCode() |
Boolean |
isBuildComplete()
Whether the build is complete.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setArn(String arn)
The Amazon Resource Name (ARN) of the build.
|
void |
setArtifacts(BuildArtifacts artifacts)
Information about the output artifacts for the build.
|
void |
setBuildBatchArn(String buildBatchArn)
The ARN of the batch build that this build is a member of, if applicable.
|
void |
setBuildComplete(Boolean buildComplete)
Whether the build is complete.
|
void |
setBuildNumber(Long buildNumber)
The number of the build.
|
void |
setBuildStatus(StatusType buildStatus)
The current status of the build.
|
void |
setBuildStatus(String buildStatus)
The current status of the build.
|
void |
setCache(ProjectCache cache)
Information about the cache for the build.
|
void |
setCurrentPhase(String currentPhase)
The current build phase.
|
void |
setDebugSession(DebugSession debugSession)
Contains information about the debug session for this build.
|
void |
setEncryptionKey(String encryptionKey)
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
|
void |
setEndTime(Date endTime)
When the build process ended, expressed in Unix time format.
|
void |
setEnvironment(ProjectEnvironment environment)
Information about the build environment for this build.
|
void |
setExportedEnvironmentVariables(Collection<ExportedEnvironmentVariable> exportedEnvironmentVariables)
A list of exported environment variables for this build.
|
void |
setFileSystemLocations(Collection<ProjectFileSystemLocation> fileSystemLocations)
An array of
ProjectFileSystemLocation objects for a CodeBuild build project. |
void |
setId(String id)
The unique ID for the build.
|
void |
setInitiator(String initiator)
The entity that started the build.
|
void |
setLogs(LogsLocation logs)
Information about the build's logs in CloudWatch Logs.
|
void |
setNetworkInterface(NetworkInterface networkInterface)
Describes a network interface.
|
void |
setPhases(Collection<BuildPhase> phases)
Information about all previous build phases that are complete and information about any current build phase that
is not yet complete.
|
void |
setProjectName(String projectName)
The name of the CodeBuild project.
|
void |
setQueuedTimeoutInMinutes(Integer queuedTimeoutInMinutes)
The number of minutes a build is allowed to be queued before it times out.
|
void |
setReportArns(Collection<String> reportArns)
An array of the ARNs associated with this build's reports.
|
void |
setResolvedSourceVersion(String resolvedSourceVersion)
An identifier for the version of this build's source code.
|
void |
setSecondaryArtifacts(Collection<BuildArtifacts> secondaryArtifacts)
An array of
ProjectArtifacts objects. |
void |
setSecondarySources(Collection<ProjectSource> secondarySources)
An array of
ProjectSource objects. |
void |
setSecondarySourceVersions(Collection<ProjectSourceVersion> secondarySourceVersions)
An array of
ProjectSourceVersion objects. |
void |
setServiceRole(String serviceRole)
The name of a service role used for this build.
|
void |
setSource(ProjectSource source)
Information about the source code to be built.
|
void |
setSourceVersion(String sourceVersion)
Any version identifier for the version of the source code to be built.
|
void |
setStartTime(Date startTime)
When the build process started, expressed in Unix time format.
|
void |
setTimeoutInMinutes(Integer timeoutInMinutes)
How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.
|
void |
setVpcConfig(VpcConfig vpcConfig)
If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC
ID and the list of security group IDs and subnet IDs.
|
String |
toString()
Returns a string representation of this object.
|
Build |
withArn(String arn)
The Amazon Resource Name (ARN) of the build.
|
Build |
withArtifacts(BuildArtifacts artifacts)
Information about the output artifacts for the build.
|
Build |
withBuildBatchArn(String buildBatchArn)
The ARN of the batch build that this build is a member of, if applicable.
|
Build |
withBuildComplete(Boolean buildComplete)
Whether the build is complete.
|
Build |
withBuildNumber(Long buildNumber)
The number of the build.
|
Build |
withBuildStatus(StatusType buildStatus)
The current status of the build.
|
Build |
withBuildStatus(String buildStatus)
The current status of the build.
|
Build |
withCache(ProjectCache cache)
Information about the cache for the build.
|
Build |
withCurrentPhase(String currentPhase)
The current build phase.
|
Build |
withDebugSession(DebugSession debugSession)
Contains information about the debug session for this build.
|
Build |
withEncryptionKey(String encryptionKey)
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
|
Build |
withEndTime(Date endTime)
When the build process ended, expressed in Unix time format.
|
Build |
withEnvironment(ProjectEnvironment environment)
Information about the build environment for this build.
|
Build |
withExportedEnvironmentVariables(Collection<ExportedEnvironmentVariable> exportedEnvironmentVariables)
A list of exported environment variables for this build.
|
Build |
withExportedEnvironmentVariables(ExportedEnvironmentVariable... exportedEnvironmentVariables)
A list of exported environment variables for this build.
|
Build |
withFileSystemLocations(Collection<ProjectFileSystemLocation> fileSystemLocations)
An array of
ProjectFileSystemLocation objects for a CodeBuild build project. |
Build |
withFileSystemLocations(ProjectFileSystemLocation... fileSystemLocations)
An array of
ProjectFileSystemLocation objects for a CodeBuild build project. |
Build |
withId(String id)
The unique ID for the build.
|
Build |
withInitiator(String initiator)
The entity that started the build.
|
Build |
withLogs(LogsLocation logs)
Information about the build's logs in CloudWatch Logs.
|
Build |
withNetworkInterface(NetworkInterface networkInterface)
Describes a network interface.
|
Build |
withPhases(BuildPhase... phases)
Information about all previous build phases that are complete and information about any current build phase that
is not yet complete.
|
Build |
withPhases(Collection<BuildPhase> phases)
Information about all previous build phases that are complete and information about any current build phase that
is not yet complete.
|
Build |
withProjectName(String projectName)
The name of the CodeBuild project.
|
Build |
withQueuedTimeoutInMinutes(Integer queuedTimeoutInMinutes)
The number of minutes a build is allowed to be queued before it times out.
|
Build |
withReportArns(Collection<String> reportArns)
An array of the ARNs associated with this build's reports.
|
Build |
withReportArns(String... reportArns)
An array of the ARNs associated with this build's reports.
|
Build |
withResolvedSourceVersion(String resolvedSourceVersion)
An identifier for the version of this build's source code.
|
Build |
withSecondaryArtifacts(BuildArtifacts... secondaryArtifacts)
An array of
ProjectArtifacts objects. |
Build |
withSecondaryArtifacts(Collection<BuildArtifacts> secondaryArtifacts)
An array of
ProjectArtifacts objects. |
Build |
withSecondarySources(Collection<ProjectSource> secondarySources)
An array of
ProjectSource objects. |
Build |
withSecondarySources(ProjectSource... secondarySources)
An array of
ProjectSource objects. |
Build |
withSecondarySourceVersions(Collection<ProjectSourceVersion> secondarySourceVersions)
An array of
ProjectSourceVersion objects. |
Build |
withSecondarySourceVersions(ProjectSourceVersion... secondarySourceVersions)
An array of
ProjectSourceVersion objects. |
Build |
withServiceRole(String serviceRole)
The name of a service role used for this build.
|
Build |
withSource(ProjectSource source)
Information about the source code to be built.
|
Build |
withSourceVersion(String sourceVersion)
Any version identifier for the version of the source code to be built.
|
Build |
withStartTime(Date startTime)
When the build process started, expressed in Unix time format.
|
Build |
withTimeoutInMinutes(Integer timeoutInMinutes)
How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.
|
Build |
withVpcConfig(VpcConfig vpcConfig)
If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC
ID and the list of security group IDs and subnet IDs.
|
public void setId(String id)
The unique ID for the build.
id
- The unique ID for the build.public String getId()
The unique ID for the build.
public Build withId(String id)
The unique ID for the build.
id
- The unique ID for the build.public void setArn(String arn)
The Amazon Resource Name (ARN) of the build.
arn
- The Amazon Resource Name (ARN) of the build.public String getArn()
The Amazon Resource Name (ARN) of the build.
public Build withArn(String arn)
The Amazon Resource Name (ARN) of the build.
arn
- The Amazon Resource Name (ARN) of the build.public void setBuildNumber(Long buildNumber)
The number of the build. For each project, the buildNumber
of its first build is 1
. The
buildNumber
of each subsequent build is incremented by 1
. If a build is deleted, the
buildNumber
of other builds does not change.
buildNumber
- The number of the build. For each project, the buildNumber
of its first build is
1
. The buildNumber
of each subsequent build is incremented by 1
. If
a build is deleted, the buildNumber
of other builds does not change.public Long getBuildNumber()
The number of the build. For each project, the buildNumber
of its first build is 1
. The
buildNumber
of each subsequent build is incremented by 1
. If a build is deleted, the
buildNumber
of other builds does not change.
buildNumber
of its first build is
1
. The buildNumber
of each subsequent build is incremented by 1
.
If a build is deleted, the buildNumber
of other builds does not change.public Build withBuildNumber(Long buildNumber)
The number of the build. For each project, the buildNumber
of its first build is 1
. The
buildNumber
of each subsequent build is incremented by 1
. If a build is deleted, the
buildNumber
of other builds does not change.
buildNumber
- The number of the build. For each project, the buildNumber
of its first build is
1
. The buildNumber
of each subsequent build is incremented by 1
. If
a build is deleted, the buildNumber
of other builds does not change.public void setStartTime(Date startTime)
When the build process started, expressed in Unix time format.
startTime
- When the build process started, expressed in Unix time format.public Date getStartTime()
When the build process started, expressed in Unix time format.
public Build withStartTime(Date startTime)
When the build process started, expressed in Unix time format.
startTime
- When the build process started, expressed in Unix time format.public void setEndTime(Date endTime)
When the build process ended, expressed in Unix time format.
endTime
- When the build process ended, expressed in Unix time format.public Date getEndTime()
When the build process ended, expressed in Unix time format.
public Build withEndTime(Date endTime)
When the build process ended, expressed in Unix time format.
endTime
- When the build process ended, expressed in Unix time format.public void setCurrentPhase(String currentPhase)
The current build phase.
currentPhase
- The current build phase.public String getCurrentPhase()
The current build phase.
public Build withCurrentPhase(String currentPhase)
The current build phase.
currentPhase
- The current build phase.public void setBuildStatus(String buildStatus)
The current status of the build. Valid values include:
FAILED
: The build failed.
FAULT
: The build faulted.
IN_PROGRESS
: The build is still in progress.
STOPPED
: The build stopped.
SUCCEEDED
: The build succeeded.
TIMED_OUT
: The build timed out.
buildStatus
- The current status of the build. Valid values include:
FAILED
: The build failed.
FAULT
: The build faulted.
IN_PROGRESS
: The build is still in progress.
STOPPED
: The build stopped.
SUCCEEDED
: The build succeeded.
TIMED_OUT
: The build timed out.
StatusType
public String getBuildStatus()
The current status of the build. Valid values include:
FAILED
: The build failed.
FAULT
: The build faulted.
IN_PROGRESS
: The build is still in progress.
STOPPED
: The build stopped.
SUCCEEDED
: The build succeeded.
TIMED_OUT
: The build timed out.
FAILED
: The build failed.
FAULT
: The build faulted.
IN_PROGRESS
: The build is still in progress.
STOPPED
: The build stopped.
SUCCEEDED
: The build succeeded.
TIMED_OUT
: The build timed out.
StatusType
public Build withBuildStatus(String buildStatus)
The current status of the build. Valid values include:
FAILED
: The build failed.
FAULT
: The build faulted.
IN_PROGRESS
: The build is still in progress.
STOPPED
: The build stopped.
SUCCEEDED
: The build succeeded.
TIMED_OUT
: The build timed out.
buildStatus
- The current status of the build. Valid values include:
FAILED
: The build failed.
FAULT
: The build faulted.
IN_PROGRESS
: The build is still in progress.
STOPPED
: The build stopped.
SUCCEEDED
: The build succeeded.
TIMED_OUT
: The build timed out.
StatusType
public void setBuildStatus(StatusType buildStatus)
The current status of the build. Valid values include:
FAILED
: The build failed.
FAULT
: The build faulted.
IN_PROGRESS
: The build is still in progress.
STOPPED
: The build stopped.
SUCCEEDED
: The build succeeded.
TIMED_OUT
: The build timed out.
buildStatus
- The current status of the build. Valid values include:
FAILED
: The build failed.
FAULT
: The build faulted.
IN_PROGRESS
: The build is still in progress.
STOPPED
: The build stopped.
SUCCEEDED
: The build succeeded.
TIMED_OUT
: The build timed out.
StatusType
public Build withBuildStatus(StatusType buildStatus)
The current status of the build. Valid values include:
FAILED
: The build failed.
FAULT
: The build faulted.
IN_PROGRESS
: The build is still in progress.
STOPPED
: The build stopped.
SUCCEEDED
: The build succeeded.
TIMED_OUT
: The build timed out.
buildStatus
- The current status of the build. Valid values include:
FAILED
: The build failed.
FAULT
: The build faulted.
IN_PROGRESS
: The build is still in progress.
STOPPED
: The build stopped.
SUCCEEDED
: The build succeeded.
TIMED_OUT
: The build timed out.
StatusType
public void setSourceVersion(String sourceVersion)
Any version identifier for the version of the source code to be built. If sourceVersion
is specified
at the project level, then this sourceVersion
(at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
sourceVersion
- Any version identifier for the version of the source code to be built. If sourceVersion
is
specified at the project level, then this sourceVersion
(at the build level) takes
precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
public String getSourceVersion()
Any version identifier for the version of the source code to be built. If sourceVersion
is specified
at the project level, then this sourceVersion
(at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
sourceVersion
is
specified at the project level, then this sourceVersion
(at the build level) takes
precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
public Build withSourceVersion(String sourceVersion)
Any version identifier for the version of the source code to be built. If sourceVersion
is specified
at the project level, then this sourceVersion
(at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
sourceVersion
- Any version identifier for the version of the source code to be built. If sourceVersion
is
specified at the project level, then this sourceVersion
(at the build level) takes
precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
public void setResolvedSourceVersion(String resolvedSourceVersion)
An identifier for the version of this build's source code.
For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For CodePipeline, the source revision provided by CodePipeline.
For Amazon S3, this does not apply.
resolvedSourceVersion
- An identifier for the version of this build's source code.
For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For CodePipeline, the source revision provided by CodePipeline.
For Amazon S3, this does not apply.
public String getResolvedSourceVersion()
An identifier for the version of this build's source code.
For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For CodePipeline, the source revision provided by CodePipeline.
For Amazon S3, this does not apply.
For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For CodePipeline, the source revision provided by CodePipeline.
For Amazon S3, this does not apply.
public Build withResolvedSourceVersion(String resolvedSourceVersion)
An identifier for the version of this build's source code.
For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For CodePipeline, the source revision provided by CodePipeline.
For Amazon S3, this does not apply.
resolvedSourceVersion
- An identifier for the version of this build's source code.
For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For CodePipeline, the source revision provided by CodePipeline.
For Amazon S3, this does not apply.
public void setProjectName(String projectName)
The name of the CodeBuild project.
projectName
- The name of the CodeBuild project.public String getProjectName()
The name of the CodeBuild project.
public Build withProjectName(String projectName)
The name of the CodeBuild project.
projectName
- The name of the CodeBuild project.public List<BuildPhase> getPhases()
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
public void setPhases(Collection<BuildPhase> phases)
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
phases
- Information about all previous build phases that are complete and information about any current build
phase that is not yet complete.public Build withPhases(BuildPhase... phases)
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
NOTE: This method appends the values to the existing list (if any). Use
setPhases(java.util.Collection)
or withPhases(java.util.Collection)
if you want to override the
existing values.
phases
- Information about all previous build phases that are complete and information about any current build
phase that is not yet complete.public Build withPhases(Collection<BuildPhase> phases)
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
phases
- Information about all previous build phases that are complete and information about any current build
phase that is not yet complete.public void setSource(ProjectSource source)
Information about the source code to be built.
source
- Information about the source code to be built.public ProjectSource getSource()
Information about the source code to be built.
public Build withSource(ProjectSource source)
Information about the source code to be built.
source
- Information about the source code to be built.public List<ProjectSource> getSecondarySources()
An array of ProjectSource
objects.
ProjectSource
objects.public void setSecondarySources(Collection<ProjectSource> secondarySources)
An array of ProjectSource
objects.
secondarySources
- An array of ProjectSource
objects.public Build withSecondarySources(ProjectSource... secondarySources)
An array of ProjectSource
objects.
NOTE: This method appends the values to the existing list (if any). Use
setSecondarySources(java.util.Collection)
or withSecondarySources(java.util.Collection)
if you
want to override the existing values.
secondarySources
- An array of ProjectSource
objects.public Build withSecondarySources(Collection<ProjectSource> secondarySources)
An array of ProjectSource
objects.
secondarySources
- An array of ProjectSource
objects.public List<ProjectSourceVersion> getSecondarySourceVersions()
An array of ProjectSourceVersion
objects. Each ProjectSourceVersion
must be one of:
For CodeCommit: the commit ID, branch, or Git tag 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 is used. If not specified, the default branch's HEAD commit ID is 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 is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
ProjectSourceVersion
objects. Each ProjectSourceVersion
must be one
of:
For CodeCommit: the commit ID, branch, or Git tag 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 is used. If not specified, the default branch's HEAD commit ID is 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 is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
public void setSecondarySourceVersions(Collection<ProjectSourceVersion> secondarySourceVersions)
An array of ProjectSourceVersion
objects. Each ProjectSourceVersion
must be one of:
For CodeCommit: the commit ID, branch, or Git tag 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 is used. If not specified, the default branch's HEAD commit ID is 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 is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
secondarySourceVersions
- An array of ProjectSourceVersion
objects. Each ProjectSourceVersion
must be one
of:
For CodeCommit: the commit ID, branch, or Git tag 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 is used. If not specified, the default branch's HEAD commit ID is 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 is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
public Build withSecondarySourceVersions(ProjectSourceVersion... secondarySourceVersions)
An array of ProjectSourceVersion
objects. Each ProjectSourceVersion
must be one of:
For CodeCommit: the commit ID, branch, or Git tag 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 is used. If not specified, the default branch's HEAD commit ID is 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 is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
NOTE: This method appends the values to the existing list (if any). Use
setSecondarySourceVersions(java.util.Collection)
or
withSecondarySourceVersions(java.util.Collection)
if you want to override the existing values.
secondarySourceVersions
- An array of ProjectSourceVersion
objects. Each ProjectSourceVersion
must be one
of:
For CodeCommit: the commit ID, branch, or Git tag 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 is used. If not specified, the default branch's HEAD commit ID is 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 is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
public Build withSecondarySourceVersions(Collection<ProjectSourceVersion> secondarySourceVersions)
An array of ProjectSourceVersion
objects. Each ProjectSourceVersion
must be one of:
For CodeCommit: the commit ID, branch, or Git tag 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 is used. If not specified, the default branch's HEAD commit ID is 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 is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
secondarySourceVersions
- An array of ProjectSourceVersion
objects. Each ProjectSourceVersion
must be one
of:
For CodeCommit: the commit ID, branch, or Git tag 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 is used. If not specified, the default branch's HEAD commit ID is 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 is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
public void setArtifacts(BuildArtifacts artifacts)
Information about the output artifacts for the build.
artifacts
- Information about the output artifacts for the build.public BuildArtifacts getArtifacts()
Information about the output artifacts for the build.
public Build withArtifacts(BuildArtifacts artifacts)
Information about the output artifacts for the build.
artifacts
- Information about the output artifacts for the build.public List<BuildArtifacts> getSecondaryArtifacts()
An array of ProjectArtifacts
objects.
ProjectArtifacts
objects.public void setSecondaryArtifacts(Collection<BuildArtifacts> secondaryArtifacts)
An array of ProjectArtifacts
objects.
secondaryArtifacts
- An array of ProjectArtifacts
objects.public Build withSecondaryArtifacts(BuildArtifacts... secondaryArtifacts)
An array of ProjectArtifacts
objects.
NOTE: This method appends the values to the existing list (if any). Use
setSecondaryArtifacts(java.util.Collection)
or withSecondaryArtifacts(java.util.Collection)
if
you want to override the existing values.
secondaryArtifacts
- An array of ProjectArtifacts
objects.public Build withSecondaryArtifacts(Collection<BuildArtifacts> secondaryArtifacts)
An array of ProjectArtifacts
objects.
secondaryArtifacts
- An array of ProjectArtifacts
objects.public void setCache(ProjectCache cache)
Information about the cache for the build.
cache
- Information about the cache for the build.public ProjectCache getCache()
Information about the cache for the build.
public Build withCache(ProjectCache cache)
Information about the cache for the build.
cache
- Information about the cache for the build.public void setEnvironment(ProjectEnvironment environment)
Information about the build environment for this build.
environment
- Information about the build environment for this build.public ProjectEnvironment getEnvironment()
Information about the build environment for this build.
public Build withEnvironment(ProjectEnvironment environment)
Information about the build environment for this build.
environment
- Information about the build environment for this build.public void setServiceRole(String serviceRole)
The name of a service role used for this build.
serviceRole
- The name of a service role used for this build.public String getServiceRole()
The name of a service role used for this build.
public Build withServiceRole(String serviceRole)
The name of a service role used for this build.
serviceRole
- The name of a service role used for this build.public void setLogs(LogsLocation logs)
Information about the build's logs in CloudWatch Logs.
logs
- Information about the build's logs in CloudWatch Logs.public LogsLocation getLogs()
Information about the build's logs in CloudWatch Logs.
public Build withLogs(LogsLocation logs)
Information about the build's logs in CloudWatch Logs.
logs
- Information about the build's logs in CloudWatch Logs.public void setTimeoutInMinutes(Integer timeoutInMinutes)
How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.
timeoutInMinutes
- How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as
completed.public Integer getTimeoutInMinutes()
How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.
public Build withTimeoutInMinutes(Integer timeoutInMinutes)
How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.
timeoutInMinutes
- How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as
completed.public void setQueuedTimeoutInMinutes(Integer queuedTimeoutInMinutes)
The number of minutes a build is allowed to be queued before it times out.
queuedTimeoutInMinutes
- The number of minutes a build is allowed to be queued before it times out.public Integer getQueuedTimeoutInMinutes()
The number of minutes a build is allowed to be queued before it times out.
public Build withQueuedTimeoutInMinutes(Integer queuedTimeoutInMinutes)
The number of minutes a build is allowed to be queued before it times out.
queuedTimeoutInMinutes
- The number of minutes a build is allowed to be queued before it times out.public void setBuildComplete(Boolean buildComplete)
Whether the build is complete. True if complete; otherwise, false.
buildComplete
- Whether the build is complete. True if complete; otherwise, false.public Boolean getBuildComplete()
Whether the build is complete. True if complete; otherwise, false.
public Build withBuildComplete(Boolean buildComplete)
Whether the build is complete. True if complete; otherwise, false.
buildComplete
- Whether the build is complete. True if complete; otherwise, false.public Boolean isBuildComplete()
Whether the build is complete. True if complete; otherwise, false.
public void setInitiator(String initiator)
The entity that started the build. Valid values include:
If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline
).
If an IAM user started the build, the user's name (for example, MyUserName
).
If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin
.
initiator
- The entity that started the build. Valid values include:
If CodePipeline started the build, the pipeline's name (for example,
codepipeline/my-demo-pipeline
).
If an IAM user started the build, the user's name (for example, MyUserName
).
If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin
.
public String getInitiator()
The entity that started the build. Valid values include:
If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline
).
If an IAM user started the build, the user's name (for example, MyUserName
).
If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin
.
If CodePipeline started the build, the pipeline's name (for example,
codepipeline/my-demo-pipeline
).
If an IAM user started the build, the user's name (for example, MyUserName
).
If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin
.
public Build withInitiator(String initiator)
The entity that started the build. Valid values include:
If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline
).
If an IAM user started the build, the user's name (for example, MyUserName
).
If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin
.
initiator
- The entity that started the build. Valid values include:
If CodePipeline started the build, the pipeline's name (for example,
codepipeline/my-demo-pipeline
).
If an IAM user started the build, the user's name (for example, MyUserName
).
If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin
.
public void setVpcConfig(VpcConfig vpcConfig)
If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
vpcConfig
- If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies
the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong
to the same VPC. You must provide at least one security group and one subnet ID.public VpcConfig getVpcConfig()
If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
public Build withVpcConfig(VpcConfig vpcConfig)
If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
vpcConfig
- If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies
the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong
to the same VPC. You must provide at least one security group and one subnet ID.public void setNetworkInterface(NetworkInterface networkInterface)
Describes a network interface.
networkInterface
- Describes a network interface.public NetworkInterface getNetworkInterface()
Describes a network interface.
public Build withNetworkInterface(NetworkInterface networkInterface)
Describes a network interface.
networkInterface
- Describes a network interface.public void setEncryptionKey(String encryptionKey)
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the
format alias/<alias-name>
).
encryptionKey
- The Key Management Service customer master key (CMK) to be used for encrypting the build output
artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using
the format alias/<alias-name>
).
public String getEncryptionKey()
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the
format alias/<alias-name>
).
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using
the format alias/<alias-name>
).
public Build withEncryptionKey(String encryptionKey)
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the
format alias/<alias-name>
).
encryptionKey
- The Key Management Service customer master key (CMK) to be used for encrypting the build output
artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using
the format alias/<alias-name>
).
public List<ExportedEnvironmentVariable> getExportedEnvironmentVariables()
A list of exported environment variables for this build.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
public void setExportedEnvironmentVariables(Collection<ExportedEnvironmentVariable> exportedEnvironmentVariables)
A list of exported environment variables for this build.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
exportedEnvironmentVariables
- A list of exported environment variables for this build.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
public Build withExportedEnvironmentVariables(ExportedEnvironmentVariable... exportedEnvironmentVariables)
A list of exported environment variables for this build.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
NOTE: This method appends the values to the existing list (if any). Use
setExportedEnvironmentVariables(java.util.Collection)
or
withExportedEnvironmentVariables(java.util.Collection)
if you want to override the existing values.
exportedEnvironmentVariables
- A list of exported environment variables for this build.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
public Build withExportedEnvironmentVariables(Collection<ExportedEnvironmentVariable> exportedEnvironmentVariables)
A list of exported environment variables for this build.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
exportedEnvironmentVariables
- A list of exported environment variables for this build.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
public List<String> getReportArns()
An array of the ARNs associated with this build's reports.
public void setReportArns(Collection<String> reportArns)
An array of the ARNs associated with this build's reports.
reportArns
- An array of the ARNs associated with this build's reports.public Build withReportArns(String... reportArns)
An array of the ARNs associated with this build's reports.
NOTE: This method appends the values to the existing list (if any). Use
setReportArns(java.util.Collection)
or withReportArns(java.util.Collection)
if you want to
override the existing values.
reportArns
- An array of the ARNs associated with this build's reports.public Build withReportArns(Collection<String> reportArns)
An array of the ARNs associated with this build's reports.
reportArns
- An array of the ARNs associated with this build's reports.public List<ProjectFileSystemLocation> getFileSystemLocations()
An array of ProjectFileSystemLocation
objects for a CodeBuild build project. A
ProjectFileSystemLocation
object specifies the identifier
, location
,
mountOptions
, mountPoint
, and type
of a file system created using Amazon
Elastic File System.
ProjectFileSystemLocation
objects for a CodeBuild build project. A
ProjectFileSystemLocation
object specifies the identifier
,
location
, mountOptions
, mountPoint
, and type
of a
file system created using Amazon Elastic File System.public void setFileSystemLocations(Collection<ProjectFileSystemLocation> fileSystemLocations)
An array of ProjectFileSystemLocation
objects for a CodeBuild build project. A
ProjectFileSystemLocation
object specifies the identifier
, location
,
mountOptions
, mountPoint
, and type
of a file system created using Amazon
Elastic File System.
fileSystemLocations
- An array of ProjectFileSystemLocation
objects for a CodeBuild build project. A
ProjectFileSystemLocation
object specifies the identifier
, location
, mountOptions
, mountPoint
, and type
of a file system created using
Amazon Elastic File System.public Build withFileSystemLocations(ProjectFileSystemLocation... fileSystemLocations)
An array of ProjectFileSystemLocation
objects for a CodeBuild build project. A
ProjectFileSystemLocation
object specifies the identifier
, location
,
mountOptions
, mountPoint
, and type
of a file system created using Amazon
Elastic File System.
NOTE: This method appends the values to the existing list (if any). Use
setFileSystemLocations(java.util.Collection)
or withFileSystemLocations(java.util.Collection)
if you want to override the existing values.
fileSystemLocations
- An array of ProjectFileSystemLocation
objects for a CodeBuild build project. A
ProjectFileSystemLocation
object specifies the identifier
, location
, mountOptions
, mountPoint
, and type
of a file system created using
Amazon Elastic File System.public Build withFileSystemLocations(Collection<ProjectFileSystemLocation> fileSystemLocations)
An array of ProjectFileSystemLocation
objects for a CodeBuild build project. A
ProjectFileSystemLocation
object specifies the identifier
, location
,
mountOptions
, mountPoint
, and type
of a file system created using Amazon
Elastic File System.
fileSystemLocations
- An array of ProjectFileSystemLocation
objects for a CodeBuild build project. A
ProjectFileSystemLocation
object specifies the identifier
, location
, mountOptions
, mountPoint
, and type
of a file system created using
Amazon Elastic File System.public void setDebugSession(DebugSession debugSession)
Contains information about the debug session for this build.
debugSession
- Contains information about the debug session for this build.public DebugSession getDebugSession()
Contains information about the debug session for this build.
public Build withDebugSession(DebugSession debugSession)
Contains information about the debug session for this build.
debugSession
- Contains information about the debug session for this build.public void setBuildBatchArn(String buildBatchArn)
The ARN of the batch build that this build is a member of, if applicable.
buildBatchArn
- The ARN of the batch build that this build is a member of, if applicable.public String getBuildBatchArn()
The ARN of the batch build that this build is a member of, if applicable.
public Build withBuildBatchArn(String buildBatchArn)
The ARN of the batch build that this build is a member of, if applicable.
buildBatchArn
- The ARN of the batch build that this build is a member of, if applicable.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.