Class Build
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Build.Builder,
Build>
Information about a build.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the build.final BuildArtifacts
Information about the output artifacts for the build.final String
The ARN of the batch build that this build is a member of, if applicable.final Boolean
Whether the build is complete.static Build.Builder
builder()
final Long
The number of the build.final StatusType
The current status of the build.final String
The current status of the build.final ProjectCache
cache()
Information about the cache for the build.final String
The current build phase.final DebugSession
Contains information about the debug session for this build.final String
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.final Instant
endTime()
When the build process ended, expressed in Unix time format.final ProjectEnvironment
Information about the build environment for this build.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<ExportedEnvironmentVariable> A list of exported environment variables for this build.final List
<ProjectFileSystemLocation> An array ofProjectFileSystemLocation
objects for a CodeBuild build project.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ExportedEnvironmentVariables property.final boolean
For responses, this returns true if the service returned a value for the FileSystemLocations property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Phases property.final boolean
For responses, this returns true if the service returned a value for the ReportArns property.final boolean
For responses, this returns true if the service returned a value for the SecondaryArtifacts property.final boolean
For responses, this returns true if the service returned a value for the SecondarySources property.final boolean
For responses, this returns true if the service returned a value for the SecondarySourceVersions property.final String
id()
The unique ID for the build.final String
The entity that started the build.final LogsLocation
logs()
Information about the build's logs in CloudWatch Logs.final NetworkInterface
Describes a network interface.final List
<BuildPhase> phases()
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.final String
The name of the CodeBuild project.final Integer
The number of minutes a build is allowed to be queued before it times out.An array of the ARNs associated with this build's reports.final String
An identifier for the version of this build's source code.final List
<BuildArtifacts> An array ofProjectArtifacts
objects.final List
<ProjectSource> An array ofProjectSource
objects.final List
<ProjectSourceVersion> An array ofProjectSourceVersion
objects.static Class
<? extends Build.Builder> final String
The name of a service role used for this build.final ProjectSource
source()
Information about the source code to be built.final String
Any version identifier for the version of the source code to be built.final Instant
When the build process started, expressed in Unix time format.final Integer
How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final 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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The unique ID for the build.
- Returns:
- The unique ID for the build.
-
arn
The Amazon Resource Name (ARN) of the build.
- Returns:
- The Amazon Resource Name (ARN) of the build.
-
buildNumber
The number of the build. For each project, the
buildNumber
of its first build is1
. ThebuildNumber
of each subsequent build is incremented by1
. If a build is deleted, thebuildNumber
of other builds does not change.- Returns:
- The number of the build. For each project, the
buildNumber
of its first build is1
. ThebuildNumber
of each subsequent build is incremented by1
. If a build is deleted, thebuildNumber
of other builds does not change.
-
startTime
When the build process started, expressed in Unix time format.
- Returns:
- When the build process started, expressed in Unix time format.
-
endTime
When the build process ended, expressed in Unix time format.
- Returns:
- When the build process ended, expressed in Unix time format.
-
currentPhase
The current build phase.
- Returns:
- The current build phase.
-
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.
If the service returns an enum value that is not available in the current SDK version,
buildStatus
will returnStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombuildStatusAsString()
.- Returns:
- 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.
-
- See Also:
-
-
buildStatusAsString
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.
If the service returns an enum value that is not available in the current SDK version,
buildStatus
will returnStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombuildStatusAsString()
.- Returns:
- 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.
-
- See Also:
-
-
sourceVersion
Any version identifier for the version of the source code to be built. If
sourceVersion
is specified at the project level, then thissourceVersion
(at the build level) takes precedence.For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
- Returns:
- Any version identifier for the version of the source code to be built. If
sourceVersion
is specified at the project level, then thissourceVersion
(at the build level) takes precedence.For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
-
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.
- Returns:
- 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.
-
-
-
projectName
The name of the CodeBuild project.
- Returns:
- The name of the CodeBuild project.
-
hasPhases
public final boolean hasPhases()For responses, this returns true if the service returned a value for the Phases property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
phases
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPhases()
method.- Returns:
- Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
-
source
Information about the source code to be built.
- Returns:
- Information about the source code to be built.
-
hasSecondarySources
public final boolean hasSecondarySources()For responses, this returns true if the service returned a value for the SecondarySources property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
secondarySources
An array of
ProjectSource
objects.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecondarySources()
method.- Returns:
- An array of
ProjectSource
objects.
-
hasSecondarySourceVersions
public final boolean hasSecondarySourceVersions()For responses, this returns true if the service returned a value for the SecondarySourceVersions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
secondarySourceVersions
An array of
ProjectSourceVersion
objects. EachProjectSourceVersion
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecondarySourceVersions()
method.- Returns:
- An array of
ProjectSourceVersion
objects. EachProjectSourceVersion
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.
-
-
-
artifacts
Information about the output artifacts for the build.
- Returns:
- Information about the output artifacts for the build.
-
hasSecondaryArtifacts
public final boolean hasSecondaryArtifacts()For responses, this returns true if the service returned a value for the SecondaryArtifacts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
secondaryArtifacts
An array of
ProjectArtifacts
objects.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecondaryArtifacts()
method.- Returns:
- An array of
ProjectArtifacts
objects.
-
cache
Information about the cache for the build.
- Returns:
- Information about the cache for the build.
-
environment
Information about the build environment for this build.
- Returns:
- Information about the build environment for this build.
-
serviceRole
The name of a service role used for this build.
- Returns:
- The name of a service role used for this build.
-
logs
Information about the build's logs in CloudWatch Logs.
- Returns:
- Information about the build's logs in CloudWatch Logs.
-
timeoutInMinutes
How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.
- Returns:
- How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.
-
queuedTimeoutInMinutes
The number of minutes a build is allowed to be queued before it times out.
- Returns:
- The number of minutes a build is allowed to be queued before it times out.
-
buildComplete
Whether the build is complete. True if complete; otherwise, false.
- Returns:
- Whether the build is complete. True if complete; otherwise, false.
-
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 a 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
.
- Returns:
- 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 a 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
.
-
-
-
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.
- Returns:
- 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.
-
networkInterface
Describes a network interface.
- Returns:
- Describes a network interface.
-
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>
).- Returns:
- 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>
).
-
hasExportedEnvironmentVariables
public final boolean hasExportedEnvironmentVariables()For responses, this returns true if the service returned a value for the ExportedEnvironmentVariables property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasExportedEnvironmentVariables()
method.- Returns:
- 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.
-
hasReportArns
public final boolean hasReportArns()For responses, this returns true if the service returned a value for the ReportArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
reportArns
An array of the ARNs associated with this build's reports.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasReportArns()
method.- Returns:
- An array of the ARNs associated with this build's reports.
-
hasFileSystemLocations
public final boolean hasFileSystemLocations()For responses, this returns true if the service returned a value for the FileSystemLocations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
fileSystemLocations
An array of
ProjectFileSystemLocation
objects for a CodeBuild build project. AProjectFileSystemLocation
object specifies theidentifier
,location
,mountOptions
,mountPoint
, andtype
of a file system created using Amazon Elastic File System.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFileSystemLocations()
method.- Returns:
- An array of
ProjectFileSystemLocation
objects for a CodeBuild build project. AProjectFileSystemLocation
object specifies theidentifier
,location
,mountOptions
,mountPoint
, andtype
of a file system created using Amazon Elastic File System.
-
debugSession
Contains information about the debug session for this build.
- Returns:
- Contains information about the debug session for this build.
-
buildBatchArn
The ARN of the batch build that this build is a member of, if applicable.
- Returns:
- The ARN of the batch build that this build is a member of, if applicable.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Build.Builder,
Build> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-