Build (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.codebuild.model.Build

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Build.Builder,Build>

@Generated(value="software.amazon.awssdk:codegen")
public final class Build
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Build.Builder,Build>

Information about a build.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Build.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Build.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the build.
`BuildArtifacts`	`artifacts()` Information about the output artifacts for the build.
`Boolean`	`buildComplete()` Whether the build is complete.
`static Build.Builder`	`builder()`
`StatusType`	`buildStatus()` The current status of the build.
`String`	`buildStatusAsString()` The current status of the build.
`ProjectCache`	`cache()` Information about the cache for the build.
`String`	`currentPhase()` The current build phase.
`String`	`encryptionKey()` The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
`Instant`	`endTime()` When the build process ended, expressed in Unix time format.
`ProjectEnvironment`	`environment()` Information about the build environment for this build.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()` The unique ID for the build.
`String`	`initiator()` The entity that started the build.
`LogsLocation`	`logs()` Information about the build's logs in Amazon CloudWatch Logs.
`NetworkInterface`	`networkInterface()` Describes a network interface.
`List<BuildPhase>`	`phases()` Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
`String`	`projectName()` The name of the AWS CodeBuild project.
`Integer`	`queuedTimeoutInMinutes()` The number of minutes a build is allowed to be queued before it times out.
`String`	`resolvedSourceVersion()` An identifier for the version of this build's source code.
`List<SdkField<?>>`	`sdkFields()`
`List<BuildArtifacts>`	`secondaryArtifacts()` An array of `ProjectArtifacts` objects.
`List<ProjectSource>`	`secondarySources()` An array of `ProjectSource` objects.
`List<ProjectSourceVersion>`	`secondarySourceVersions()` An array of `ProjectSourceVersion` objects.
`static Class<? extends Build.Builder>`	`serializableBuilderClass()`
`String`	`serviceRole()` The name of a service role used for this build.
`ProjectSource`	`source()` Information about the source code to be built.
`String`	`sourceVersion()` Any version identifier for the version of the source code to be built.
`Instant`	`startTime()` When the build process started, expressed in Unix time format.
`Integer`	`timeoutInMinutes()` How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.
`Build.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`VpcConfig`	`vpcConfig()` If your AWS 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 class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - id
```
public String id()
```
    The unique ID for the build.
    
    Returns:
    
    The unique ID for the build.
  - arn
```
public String arn()
```
    The Amazon Resource Name (ARN) of the build.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the build.
  - startTime
```
public Instant startTime()
```
    When the build process started, expressed in Unix time format.
    
    Returns:
    
    When the build process started, expressed in Unix time format.
  - endTime
```
public Instant endTime()
```
    When the build process ended, expressed in Unix time format.
    
    Returns:
    
    When the build process ended, expressed in Unix time format.
  - currentPhase
```
public String currentPhase()
```
    The current build phase.
    
    Returns:
    
    The current build phase.
  - buildStatus
```
public 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.
    If the service returns an enum value that is not available in the current SDK version, buildStatus will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from buildStatusAsString().
    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:
    
    StatusType
  - buildStatusAsString
```
public String 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 return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from buildStatusAsString().
    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:
    
    StatusType
  - sourceVersion
```
public String sourceVersion()
```
    Any version identifier for the version of the source code to be built.
    
    Returns:
    
    Any version identifier for the version of the source code to be built.
  - resolvedSourceVersion
```
public String resolvedSourceVersion()
```
    An identifier for the version of this build's source code.
    - For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
    - For AWS CodePipeline, the source revision provided by AWS CodePipeline.
    - For Amazon Simple Storage Service (Amazon S3), this does not apply.
    Returns:
    An identifier for the version of this build's source code.
    
    For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
    
    For AWS CodePipeline, the source revision provided by AWS CodePipeline.
    
    For Amazon Simple Storage Service (Amazon S3), this does not apply.
  - projectName
```
public String projectName()
```
    The name of the AWS CodeBuild project.
    
    Returns:
    
    The name of the AWS CodeBuild project.
  - phases
```
public List<BuildPhase> 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.
    
    Returns:
    
    Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
  - source
```
public ProjectSource source()
```
    Information about the source code to be built.
    
    Returns:
    
    Information about the source code to be built.
  - secondarySources
```
public List<ProjectSource> secondarySources()
```
    An array of ProjectSource objects.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    An array of ProjectSource objects.
  - secondarySourceVersions
```
public List<ProjectSourceVersion> secondarySourceVersions()
```
    An array of ProjectSourceVersion objects. Each ProjectSourceVersion 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 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 Simple Storage Service (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.
    Returns:
    An array of ProjectSourceVersion objects. Each ProjectSourceVersion 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 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 Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
  - artifacts
```
public BuildArtifacts artifacts()
```
    Information about the output artifacts for the build.
    
    Returns:
    
    Information about the output artifacts for the build.
  - secondaryArtifacts
```
public List<BuildArtifacts> secondaryArtifacts()
```
    An array of ProjectArtifacts objects.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    An array of ProjectArtifacts objects.
  - cache
```
public ProjectCache cache()
```
    Information about the cache for the build.
    
    Returns:
    
    Information about the cache for the build.
  - environment
```
public ProjectEnvironment environment()
```
    Information about the build environment for this build.
    
    Returns:
    
    Information about the build environment for this build.
  - serviceRole
```
public String serviceRole()
```
    The name of a service role used for this build.
    
    Returns:
    
    The name of a service role used for this build.
  - logs
```
public LogsLocation logs()
```
    Information about the build's logs in Amazon CloudWatch Logs.
    
    Returns:
    
    Information about the build's logs in Amazon CloudWatch Logs.
  - timeoutInMinutes
```
public Integer timeoutInMinutes()
```
    How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.
    
    Returns:
    
    How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.
  - queuedTimeoutInMinutes
```
public Integer 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
```
public Boolean buildComplete()
```
    Whether the build is complete. True if complete; otherwise, false.
    
    Returns:
    
    Whether the build is complete. True if complete; otherwise, false.
  - initiator
```
public String initiator()
```
    The entity that started the build. Valid values include:
    - If AWS CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).
    - If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example, MyUserName).
    - If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
    Returns:
    The entity that started the build. Valid values include:
    
    If AWS CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).
    
    If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example, MyUserName).
    
    If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
  - vpcConfig
```
public VpcConfig vpcConfig()
```
    If your AWS 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 AWS 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
```
public NetworkInterface networkInterface()
```
    Describes a network interface.
    
    Returns:
    
    Describes a network interface.
  - encryptionKey
```
public String encryptionKey()
```
    The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
    
    This is expressed either as the Amazon Resource Name (ARN) of the CMK or, if specified, the CMK's alias (using the format alias/alias-name ).
    
    Returns:
    
    The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
    
    This is expressed either as the Amazon Resource Name (ARN) of the CMK or, if specified, the CMK's alias (using the format alias/alias-name ).
  - toBuilder
```
public Build.Builder 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 interface ToCopyableBuilder<Build.Builder,Build>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Build.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Build.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class Build

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

arn

startTime

endTime

currentPhase

buildStatus

buildStatusAsString

sourceVersion

resolvedSourceVersion

projectName

phases

source

secondarySources

secondarySourceVersions

artifacts

secondaryArtifacts

cache

environment

serviceRole

logs

timeoutInMinutes

queuedTimeoutInMinutes

buildComplete

initiator

vpcConfig

networkInterface

encryptionKey

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields