@Generated(value="software.amazon.awssdk:codegen") public final class BuildBatch extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BuildBatch.Builder,BuildBatch>
Contains information about a batch build.
Modifier and Type | Class and Description |
---|---|
static interface |
BuildBatch.Builder |
Modifier and Type | Method and Description |
---|---|
String |
arn()
The ARN of the batch build.
|
BuildArtifacts |
artifacts()
A
BuildArtifacts object the defines the build artifacts for this batch build. |
ProjectBuildBatchConfig |
buildBatchConfig()
Returns the value of the BuildBatchConfig property for this object.
|
Long |
buildBatchNumber()
The number of the batch build.
|
StatusType |
buildBatchStatus()
The status of the batch build.
|
String |
buildBatchStatusAsString()
The status of the batch build.
|
static BuildBatch.Builder |
builder() |
List<BuildGroup> |
buildGroups()
An array of
BuildGroup objects that define the build groups for the batch build. |
Integer |
buildTimeoutInMinutes()
Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.
|
ProjectCache |
cache()
Returns the value of the Cache property for this object.
|
Boolean |
complete()
Indicates if the batch build is complete.
|
String |
currentPhase()
The current phase of the batch build.
|
String |
encryptionKey()
The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the batch build
output artifacts.
|
Instant |
endTime()
The date and time that the batch build ended.
|
ProjectEnvironment |
environment()
Returns the value of the Environment property for this object.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
List<ProjectFileSystemLocation> |
fileSystemLocations()
An array of
ProjectFileSystemLocation objects for the batch build project. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasBuildGroups()
Returns true if the BuildGroups property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasFileSystemLocations()
Returns true if the FileSystemLocations property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasPhases()
Returns true if the Phases property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
boolean |
hasSecondaryArtifacts()
Returns true if the SecondaryArtifacts property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasSecondarySources()
Returns true if the SecondarySources property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasSecondarySourceVersions()
Returns true if the SecondarySourceVersions property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
String |
id()
The identifier of the batch build.
|
String |
initiator()
The entity that started the batch build.
|
LogsConfig |
logConfig()
Returns the value of the LogConfig property for this object.
|
List<BuildBatchPhase> |
phases()
An array of
BuildBatchPhase objects the specify the phases of the batch build. |
String |
projectName()
The name of the batch build project.
|
Integer |
queuedTimeoutInMinutes()
Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.
|
String |
resolvedSourceVersion()
The identifier of the resolved version of this batch build's source code.
|
List<SdkField<?>> |
sdkFields() |
List<BuildArtifacts> |
secondaryArtifacts()
An array of
BuildArtifacts objects the define the build artifacts for this batch build. |
List<ProjectSource> |
secondarySources()
An array of
ProjectSource objects that define the sources for the batch build. |
List<ProjectSourceVersion> |
secondarySourceVersions()
An array of
ProjectSourceVersion objects. |
static Class<? extends BuildBatch.Builder> |
serializableBuilderClass() |
String |
serviceRole()
The name of a service role used for builds in the batch.
|
ProjectSource |
source()
Returns the value of the Source property for this object.
|
String |
sourceVersion()
The identifier of the version of the source code to be built.
|
Instant |
startTime()
The date and time that the batch build started.
|
BuildBatch.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
VpcConfig |
vpcConfig()
Returns the value of the VpcConfig property for this object.
|
copy
public final String id()
The identifier of the batch build.
public final String arn()
The ARN of the batch build.
public final Instant startTime()
The date and time that the batch build started.
public final Instant endTime()
The date and time that the batch build ended.
public final String currentPhase()
The current phase of the batch build.
public final StatusType buildBatchStatus()
The status of the batch build.
If the service returns an enum value that is not available in the current SDK version, buildBatchStatus
will return StatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
buildBatchStatusAsString()
.
StatusType
public final String buildBatchStatusAsString()
The status of the batch build.
If the service returns an enum value that is not available in the current SDK version, buildBatchStatus
will return StatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
buildBatchStatusAsString()
.
StatusType
public final String sourceVersion()
The identifier of the version of the source code to be built.
public final String resolvedSourceVersion()
The identifier of the resolved version of this batch 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.
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.
public final String projectName()
The name of the batch build project.
public final boolean hasPhases()
public final List<BuildBatchPhase> phases()
An array of BuildBatchPhase
objects the specify the phases of the batch build.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasPhases()
to see if a value was sent in this field.
BuildBatchPhase
objects the specify the phases of the batch build.public final ProjectSource source()
public final boolean hasSecondarySources()
public final List<ProjectSource> secondarySources()
An array of ProjectSource
objects that define the sources for the batch build.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasSecondarySources()
to see if a value was sent in this field.
ProjectSource
objects that define the sources for the batch build.public final boolean hasSecondarySourceVersions()
public final List<ProjectSourceVersion> secondarySourceVersions()
An array of ProjectSourceVersion
objects. Each ProjectSourceVersion
must be one of:
For AWS 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 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.
You can use hasSecondarySourceVersions()
to see if a value was sent in this field.
ProjectSourceVersion
objects. Each ProjectSourceVersion
must be one
of:
For AWS 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 Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
public final BuildArtifacts artifacts()
A BuildArtifacts
object the defines the build artifacts for this batch build.
BuildArtifacts
object the defines the build artifacts for this batch build.public final boolean hasSecondaryArtifacts()
public final List<BuildArtifacts> secondaryArtifacts()
An array of BuildArtifacts
objects the define the build artifacts for this batch build.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasSecondaryArtifacts()
to see if a value was sent in this field.
BuildArtifacts
objects the define the build artifacts for this batch build.public final ProjectCache cache()
public final ProjectEnvironment environment()
public final String serviceRole()
The name of a service role used for builds in the batch.
public final LogsConfig logConfig()
public final Integer buildTimeoutInMinutes()
Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.
public final Integer queuedTimeoutInMinutes()
Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.
public final Boolean complete()
Indicates if the batch build is complete.
public final String initiator()
The entity that started the batch 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.
If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin
.
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.
If the Jenkins plugin for AWS CodeBuild started the build, the string
CodeBuild-Jenkins-Plugin
.
public final VpcConfig vpcConfig()
public final String encryptionKey()
The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the batch 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 final Long buildBatchNumber()
The number of the batch build. For each project, the buildBatchNumber
of its first batch build is
1
. The buildBatchNumber
of each subsequent batch build is incremented by 1
. If a batch build is deleted, the buildBatchNumber
of other batch builds does not change.
buildBatchNumber
of its first batch
build is 1
. The buildBatchNumber
of each subsequent batch build is incremented
by 1
. If a batch build is deleted, the buildBatchNumber
of other batch builds
does not change.public final boolean hasFileSystemLocations()
public final List<ProjectFileSystemLocation> fileSystemLocations()
An array of ProjectFileSystemLocation
objects for the batch build project. A
ProjectFileSystemLocation
object specifies the identifier
, location
,
mountOptions
, mountPoint
, and type
of a file system created using Amazon
Elastic File System.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasFileSystemLocations()
to see if a value was sent in this field.
ProjectFileSystemLocation
objects for the batch build project. A
ProjectFileSystemLocation
object specifies the identifier
,
location
, mountOptions
, mountPoint
, and type
of a
file system created using Amazon Elastic File System.public final ProjectBuildBatchConfig buildBatchConfig()
public final boolean hasBuildGroups()
public final List<BuildGroup> buildGroups()
An array of BuildGroup
objects that define the build groups for the batch build.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasBuildGroups()
to see if a value was sent in this field.
BuildGroup
objects that define the build groups for the batch build.public BuildBatch.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<BuildBatch.Builder,BuildBatch>
public static BuildBatch.Builder builder()
public static Class<? extends BuildBatch.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.