@Generated(value="software.amazon.awssdk:codegen") public final class StartBuildBatchRequest extends CodeBuildRequest implements ToCopyableBuilder<StartBuildBatchRequest.Builder,StartBuildBatchRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
StartBuildBatchRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
ProjectArtifacts |
artifactsOverride()
An array of
ProjectArtifacts objects that contains information about the build output artifact
overrides for the build project. |
ProjectBuildBatchConfig |
buildBatchConfigOverride()
A
BuildBatchConfigOverride object that contains batch build configuration overrides. |
static StartBuildBatchRequest.Builder |
builder() |
String |
buildspecOverride()
A buildspec file declaration that overrides, for this build only, the latest one already defined in the build
project.
|
Integer |
buildTimeoutInMinutesOverride()
Overrides the build timeout specified in the batch build project.
|
ProjectCache |
cacheOverride()
A
ProjectCache object that specifies cache overrides. |
String |
certificateOverride()
The name of a certificate for this batch build that overrides the one specified in the batch build project.
|
ComputeType |
computeTypeOverride()
The name of a compute type for this batch build that overrides the one specified in the batch build project.
|
String |
computeTypeOverrideAsString()
The name of a compute type for this batch build that overrides the one specified in the batch build project.
|
Boolean |
debugSessionEnabled()
Specifies if session debugging is enabled for this batch build.
|
String |
encryptionKeyOverride()
The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the batch
build project.
|
EnvironmentType |
environmentTypeOverride()
A container type for this batch build that overrides the one specified in the batch build project.
|
String |
environmentTypeOverrideAsString()
A container type for this batch build that overrides the one specified in the batch build project.
|
List<EnvironmentVariable> |
environmentVariablesOverride()
An array of
EnvironmentVariable objects that override, or add to, the environment variables defined
in the batch build project. |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
Integer |
gitCloneDepthOverride()
The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any
previous depth of history defined in the batch build project.
|
GitSubmodulesConfig |
gitSubmodulesConfigOverride()
A
GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build. |
boolean |
hasEnvironmentVariablesOverride()
Returns true if the EnvironmentVariablesOverride 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 |
hasSecondaryArtifactsOverride()
Returns true if the SecondaryArtifactsOverride 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 |
hasSecondarySourcesOverride()
Returns true if the SecondarySourcesOverride 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 |
hasSecondarySourcesVersionOverride()
Returns true if the SecondarySourcesVersionOverride 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 |
idempotencyToken()
A unique, case sensitive identifier you provide to ensure the idempotency of the
StartBuildBatch
request. |
String |
imageOverride()
The name of an image for this batch build that overrides the one specified in the batch build project.
|
ImagePullCredentialsType |
imagePullCredentialsTypeOverride()
The type of credentials AWS CodeBuild uses to pull images in your batch build.
|
String |
imagePullCredentialsTypeOverrideAsString()
The type of credentials AWS CodeBuild uses to pull images in your batch build.
|
Boolean |
insecureSslOverride()
Enable this flag to override the insecure SSL setting that is specified in the batch build project.
|
LogsConfig |
logsConfigOverride()
A
LogsConfig object that override the log settings defined in the batch build project. |
Boolean |
privilegedModeOverride()
Enable this flag to override privileged mode in the batch build project.
|
String |
projectName()
The name of the project.
|
Integer |
queuedTimeoutInMinutesOverride()
The number of minutes a batch build is allowed to be queued before it times out.
|
RegistryCredential |
registryCredentialOverride()
A
RegistryCredential object that overrides credentials for access to a private registry. |
Boolean |
reportBuildBatchStatusOverride()
Set to
true to report to your source provider the status of a batch build's start and completion. |
List<SdkField<?>> |
sdkFields() |
List<ProjectArtifacts> |
secondaryArtifactsOverride()
An array of
ProjectArtifacts objects that override the secondary artifacts defined in the batch
build project. |
List<ProjectSource> |
secondarySourcesOverride()
An array of
ProjectSource objects that override the secondary sources defined in the batch build
project. |
List<ProjectSourceVersion> |
secondarySourcesVersionOverride()
An array of
ProjectSourceVersion objects that override the secondary source versions in the batch
build project. |
static Class<? extends StartBuildBatchRequest.Builder> |
serializableBuilderClass() |
String |
serviceRoleOverride()
The name of a service role for this batch build that overrides the one specified in the batch build project.
|
SourceAuth |
sourceAuthOverride()
A
SourceAuth object that overrides the one defined in the batch build project. |
String |
sourceLocationOverride()
A location that overrides, for this batch build, the source location defined in the batch build project.
|
SourceType |
sourceTypeOverride()
The source input type that overrides the source input defined in the batch build project.
|
String |
sourceTypeOverrideAsString()
The source input type that overrides the source input defined in the batch build project.
|
String |
sourceVersion()
The version of the batch build input to be built, for this build only.
|
StartBuildBatchRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String projectName()
The name of the project.
public final boolean hasSecondarySourcesOverride()
public final List<ProjectSource> secondarySourcesOverride()
An array of ProjectSource objects that override the secondary sources defined in the batch build
project.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasSecondarySourcesOverride() to see if a value was sent in this field.
ProjectSource objects that override the secondary sources defined in the batch
build project.public final boolean hasSecondarySourcesVersionOverride()
public final List<ProjectSourceVersion> secondarySourcesVersionOverride()
An array of ProjectSourceVersion objects that override the secondary source versions in the batch
build project.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasSecondarySourcesVersionOverride() to see if a value was sent in this field.
ProjectSourceVersion objects that override the secondary source versions in the
batch build project.public final String sourceVersion()
The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
The commit ID, branch, or Git tag to use.
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.
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.
The version ID of the object that represents the build input ZIP file to use.
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 AWS CodeBuild User Guide.
The commit ID, branch, or Git tag to use.
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.
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.
The version ID of the object that represents the build input ZIP file to use.
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 AWS CodeBuild User Guide.
public final ProjectArtifacts artifactsOverride()
An array of ProjectArtifacts objects that contains information about the build output artifact
overrides for the build project.
ProjectArtifacts objects that contains information about the build output
artifact overrides for the build project.public final boolean hasSecondaryArtifactsOverride()
public final List<ProjectArtifacts> secondaryArtifactsOverride()
An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch
build project.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasSecondaryArtifactsOverride() to see if a value was sent in this field.
ProjectArtifacts objects that override the secondary artifacts defined in the
batch build project.public final boolean hasEnvironmentVariablesOverride()
public final List<EnvironmentVariable> environmentVariablesOverride()
An array of EnvironmentVariable objects that override, or add to, the environment variables defined
in the batch build project.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasEnvironmentVariablesOverride() to see if a value was sent in this field.
EnvironmentVariable objects that override, or add to, the environment variables
defined in the batch build project.public final SourceType sourceTypeOverride()
The source input type that overrides the source input defined in the batch build project.
If the service returns an enum value that is not available in the current SDK version,
sourceTypeOverride will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the
service is available from sourceTypeOverrideAsString().
SourceTypepublic final String sourceTypeOverrideAsString()
The source input type that overrides the source input defined in the batch build project.
If the service returns an enum value that is not available in the current SDK version,
sourceTypeOverride will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the
service is available from sourceTypeOverrideAsString().
SourceTypepublic final String sourceLocationOverride()
A location that overrides, for this batch build, the source location defined in the batch build project.
public final SourceAuth sourceAuthOverride()
A SourceAuth object that overrides the one defined in the batch build project. This override applies
only if the build project's source is BitBucket or GitHub.
SourceAuth object that overrides the one defined in the batch build project. This override
applies only if the build project's source is BitBucket or GitHub.public final Integer gitCloneDepthOverride()
The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any previous depth of history defined in the batch build project.
public final GitSubmodulesConfig gitSubmodulesConfigOverride()
A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.
GitSubmodulesConfig object that overrides the Git submodules configuration for this batch
build.public final String buildspecOverride()
A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file
relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3
bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN
(for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is
set to an empty string, the source code must contain a buildspec file in its root directory. For more
information, see Buildspec File Name and Storage Location.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec
file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the
path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the
buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml).
If this value is not provided or is set to an empty string, the source code must contain a buildspec file
in its root directory. For more information, see Buildspec File Name and Storage Location.
public final Boolean insecureSslOverride()
Enable this flag to override the insecure SSL setting that is specified in the batch build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.
public final Boolean reportBuildBatchStatusOverride()
Set to true to report to your source provider the status of a batch build's start and completion. If
you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an
invalidInputException is thrown.
The status of a build triggered by a webhook is always reported to your source provider.
true to report to your source provider the status of a batch build's start and
completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or
Bitbucket, an invalidInputException is thrown. The status of a build triggered by a webhook is always reported to your source provider.
public final EnvironmentType environmentTypeOverride()
A container type for this batch build that overrides the one specified in the batch build project.
If the service returns an enum value that is not available in the current SDK version,
environmentTypeOverride will return EnvironmentType.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from environmentTypeOverrideAsString().
EnvironmentTypepublic final String environmentTypeOverrideAsString()
A container type for this batch build that overrides the one specified in the batch build project.
If the service returns an enum value that is not available in the current SDK version,
environmentTypeOverride will return EnvironmentType.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from environmentTypeOverrideAsString().
EnvironmentTypepublic final String imageOverride()
The name of an image for this batch build that overrides the one specified in the batch build project.
public final ComputeType computeTypeOverride()
The name of a compute type for this batch build that overrides the one specified in the batch build project.
If the service returns an enum value that is not available in the current SDK version,
computeTypeOverride will return ComputeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by
the service is available from computeTypeOverrideAsString().
ComputeTypepublic final String computeTypeOverrideAsString()
The name of a compute type for this batch build that overrides the one specified in the batch build project.
If the service returns an enum value that is not available in the current SDK version,
computeTypeOverride will return ComputeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by
the service is available from computeTypeOverrideAsString().
ComputeTypepublic final String certificateOverride()
The name of a certificate for this batch build that overrides the one specified in the batch build project.
public final ProjectCache cacheOverride()
A ProjectCache object that specifies cache overrides.
ProjectCache object that specifies cache overrides.public final String serviceRoleOverride()
The name of a service role for this batch build that overrides the one specified in the batch build project.
public final Boolean privilegedModeOverride()
Enable this flag to override privileged mode in the batch build project.
public final Integer buildTimeoutInMinutesOverride()
Overrides the build timeout specified in the batch build project.
public final Integer queuedTimeoutInMinutesOverride()
The number of minutes a batch build is allowed to be queued before it times out.
public final String encryptionKeyOverride()
The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts 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 final String idempotencyToken()
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch
request. The token is included in the StartBuildBatch request and is valid for five minutes. If you
repeat the StartBuildBatch request with the same token, but change a parameter, AWS CodeBuild
returns a parameter mismatch error.
StartBuildBatch request. The token is included in the StartBuildBatch request
and is valid for five minutes. If you repeat the StartBuildBatch request with the same
token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.public final LogsConfig logsConfigOverride()
A LogsConfig object that override the log settings defined in the batch build project.
LogsConfig object that override the log settings defined in the batch build project.public final RegistryCredential registryCredentialOverride()
A RegistryCredential object that overrides credentials for access to a private registry.
RegistryCredential object that overrides credentials for access to a private registry.public final ImagePullCredentialsType imagePullCredentialsTypeOverride()
The type of credentials AWS CodeBuild uses to pull images in your batch build. There are two valid values:
Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
Specifies that AWS CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When
using an AWS CodeBuild curated image, you must use CODEBUILD credentials.
If the service returns an enum value that is not available in the current SDK version,
imagePullCredentialsTypeOverride will return ImagePullCredentialsType.UNKNOWN_TO_SDK_VERSION.
The raw value returned by the service is available from imagePullCredentialsTypeOverrideAsString().
Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
Specifies that AWS CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE credentials.
When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.
ImagePullCredentialsTypepublic final String imagePullCredentialsTypeOverrideAsString()
The type of credentials AWS CodeBuild uses to pull images in your batch build. There are two valid values:
Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
Specifies that AWS CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When
using an AWS CodeBuild curated image, you must use CODEBUILD credentials.
If the service returns an enum value that is not available in the current SDK version,
imagePullCredentialsTypeOverride will return ImagePullCredentialsType.UNKNOWN_TO_SDK_VERSION.
The raw value returned by the service is available from imagePullCredentialsTypeOverrideAsString().
Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
Specifies that AWS CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE credentials.
When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.
ImagePullCredentialsTypepublic final ProjectBuildBatchConfig buildBatchConfigOverride()
A BuildBatchConfigOverride object that contains batch build configuration overrides.
BuildBatchConfigOverride object that contains batch build configuration overrides.public final Boolean debugSessionEnabled()
Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.
public StartBuildBatchRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<StartBuildBatchRequest.Builder,StartBuildBatchRequest>toBuilder in class CodeBuildRequestpublic static StartBuildBatchRequest.Builder builder()
public static Class<? extends StartBuildBatchRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.