Build (AWS SDK for Java - 2.0.0-preview-11)

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

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<Build.Builder,Build>

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

Information about a build.

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 has finished.
`static Build.Builder`	`builder()`
`StatusType`	`buildStatus()` The current status of the build.
`String`	`buildStatusAsString()` The current status of the build.
`String`	`currentPhase()` The current build phase.
`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.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`List<BuildPhase>`	`phases()` Information about all previous build phases that are completed and information about any current build phase that is not yet complete.
`String`	`projectName()` The name of the build project.
`static Class<? extends Build.Builder>`	`serializableBuilderClass()`
`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()`

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.
  - projectName
```
public String projectName()
```
    The name of the build project.
    
    Returns:
    
    The name of the build project.
  - phases
```
public List<BuildPhase> phases()
```
    Information about all previous build phases that are completed 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 completed 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.
  - artifacts
```
public BuildArtifacts artifacts()
```
    Information about the output artifacts for the build.
    
    Returns:
    
    Information about the output artifacts for the build.
  - environment
```
public ProjectEnvironment environment()
```
    Information about the build environment for this build.
    
    Returns:
    
    Information about the build environment 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.
  - buildComplete
```
public Boolean buildComplete()
```
    Whether the build has finished. True if completed; otherwise, false.
    
    Returns:
    
    Whether the build has finished. True if completed; 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.
  - 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)
```
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

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

projectName

phases

source

artifacts

environment

logs

timeoutInMinutes

buildComplete

initiator

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall