Class StartBuildBatchRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartBuildBatchRequest.Builder,
StartBuildBatchRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ProjectArtifacts
An array ofProjectArtifacts
objects that contains information about the build output artifact overrides for the build project.final ProjectBuildBatchConfig
ABuildBatchConfigOverride
object that contains batch build configuration overrides.builder()
final String
A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.final Integer
Overrides the build timeout specified in the batch build project.final ProjectCache
AProjectCache
object that specifies cache overrides.final String
The name of a certificate for this batch build that overrides the one specified in the batch build project.final ComputeType
The name of a compute type for this batch build that overrides the one specified in the batch build project.final String
The name of a compute type for this batch build that overrides the one specified in the batch build project.final Boolean
Specifies if session debugging is enabled for this batch build.final String
The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project.final EnvironmentType
A container type for this batch build that overrides the one specified in the batch build project.final String
A container type for this batch build that overrides the one specified in the batch build project.final List
<EnvironmentVariable> An array ofEnvironmentVariable
objects that override, or add to, the environment variables defined in the batch build project.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final Integer
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.final GitSubmodulesConfig
AGitSubmodulesConfig
object that overrides the Git submodules configuration for this batch build.final boolean
For responses, this returns true if the service returned a value for the EnvironmentVariablesOverride property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SecondaryArtifactsOverride property.final boolean
For responses, this returns true if the service returned a value for the SecondarySourcesOverride property.final boolean
For responses, this returns true if the service returned a value for the SecondarySourcesVersionOverride property.final String
A unique, case sensitive identifier you provide to ensure the idempotency of theStartBuildBatch
request.final String
The name of an image for this batch build that overrides the one specified in the batch build project.final ImagePullCredentialsType
The type of credentials CodeBuild uses to pull images in your batch build.final String
The type of credentials CodeBuild uses to pull images in your batch build.final Boolean
Enable this flag to override the insecure SSL setting that is specified in the batch build project.final LogsConfig
ALogsConfig
object that override the log settings defined in the batch build project.final Boolean
Enable this flag to override privileged mode in the batch build project.final String
The name of the project.final Integer
The number of minutes a batch build is allowed to be queued before it times out.final RegistryCredential
ARegistryCredential
object that overrides credentials for access to a private registry.final Boolean
Set totrue
to report to your source provider the status of a batch build's start and completion.final List
<ProjectArtifacts> An array ofProjectArtifacts
objects that override the secondary artifacts defined in the batch build project.final List
<ProjectSource> An array ofProjectSource
objects that override the secondary sources defined in the batch build project.final List
<ProjectSourceVersion> An array ofProjectSourceVersion
objects that override the secondary source versions in the batch build project.static Class
<? extends StartBuildBatchRequest.Builder> final String
The name of a service role for this batch build that overrides the one specified in the batch build project.final SourceAuth
ASourceAuth
object that overrides the one defined in the batch build project.final String
A location that overrides, for this batch build, the source location defined in the batch build project.final SourceType
The source input type that overrides the source input defined in the batch build project.final String
The source input type that overrides the source input defined in the batch build project.final String
The version of the batch build input to be built, for this build only.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
projectName
The name of the project.
- Returns:
- The name of the project.
-
hasSecondarySourcesOverride
public final boolean hasSecondarySourcesOverride()For responses, this returns true if the service returned a value for the SecondarySourcesOverride 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. -
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.
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
hasSecondarySourcesOverride()
method.- Returns:
- An array of
ProjectSource
objects that override the secondary sources defined in the batch build project.
-
hasSecondarySourcesVersionOverride
public final boolean hasSecondarySourcesVersionOverride()For responses, this returns true if the service returned a value for the SecondarySourcesVersionOverride 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. -
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.
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
hasSecondarySourcesVersionOverride()
method.- Returns:
- An array of
ProjectSourceVersion
objects that override the secondary source versions in the batch build project.
-
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:
- CodeCommit
-
The commit ID, branch, or Git tag to use.
- 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 examplepr/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. - 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.
- Amazon S3
-
The version ID of the object that represents the build input ZIP file to use.
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:
- 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:
- CodeCommit
-
The commit ID, branch, or Git tag to use.
- 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 examplepr/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. - 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.
- Amazon S3
-
The version ID of the object that represents the build input ZIP file to use.
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.
-
artifactsOverride
An array of
ProjectArtifacts
objects that contains information about the build output artifact overrides for the build project.- Returns:
- An array of
ProjectArtifacts
objects that contains information about the build output artifact overrides for the build project.
-
hasSecondaryArtifactsOverride
public final boolean hasSecondaryArtifactsOverride()For responses, this returns true if the service returned a value for the SecondaryArtifactsOverride 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. -
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.
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
hasSecondaryArtifactsOverride()
method.- Returns:
- An array of
ProjectArtifacts
objects that override the secondary artifacts defined in the batch build project.
-
hasEnvironmentVariablesOverride
public final boolean hasEnvironmentVariablesOverride()For responses, this returns true if the service returned a value for the EnvironmentVariablesOverride 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. -
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.
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
hasEnvironmentVariablesOverride()
method.- Returns:
- An array of
EnvironmentVariable
objects that override, or add to, the environment variables defined in the batch build project.
-
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 returnSourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceTypeOverrideAsString()
.- Returns:
- The source input type that overrides the source input defined in the batch build project.
- See Also:
-
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 returnSourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceTypeOverrideAsString()
.- Returns:
- The source input type that overrides the source input defined in the batch build project.
- See Also:
-
sourceLocationOverride
A location that overrides, for this batch build, the source location defined in the batch build project.
- Returns:
- A location that overrides, for this batch build, the source location defined in the batch build project.
-
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.- Returns:
- 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.
-
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.
- Returns:
- 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.
-
gitSubmodulesConfigOverride
A
GitSubmodulesConfig
object that overrides the Git submodules configuration for this batch build.- Returns:
- A
GitSubmodulesConfig
object that overrides the Git submodules configuration for this batch build.
-
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 Amazon Web Services 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.- Returns:
- 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 Amazon Web Services 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.
-
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.
- Returns:
- 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.
-
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, aninvalidInputException
is thrown.The status of a build triggered by a webhook is always reported to your source provider.
- Returns:
- 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, aninvalidInputException
is thrown.The status of a build triggered by a webhook is always reported to your source provider.
-
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 returnEnvironmentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromenvironmentTypeOverrideAsString()
.- Returns:
- A container type for this batch build that overrides the one specified in the batch build project.
- See Also:
-
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 returnEnvironmentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromenvironmentTypeOverrideAsString()
.- Returns:
- A container type for this batch build that overrides the one specified in the batch build project.
- See Also:
-
imageOverride
The name of an image for this batch build that overrides the one specified in the batch build project.
- Returns:
- The name of an image for this batch build that overrides the one specified in the batch build project.
-
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 returnComputeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomputeTypeOverrideAsString()
.- Returns:
- The name of a compute type for this batch build that overrides the one specified in the batch build project.
- See Also:
-
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 returnComputeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomputeTypeOverrideAsString()
.- Returns:
- The name of a compute type for this batch build that overrides the one specified in the batch build project.
- See Also:
-
certificateOverride
The name of a certificate for this batch build that overrides the one specified in the batch build project.
- Returns:
- The name of a certificate for this batch build that overrides the one specified in the batch build project.
-
cacheOverride
A
ProjectCache
object that specifies cache overrides.- Returns:
- A
ProjectCache
object that specifies cache overrides.
-
serviceRoleOverride
The name of a service role for this batch build that overrides the one specified in the batch build project.
- Returns:
- The name of a service role for this batch build that overrides the one specified in the batch build project.
-
privilegedModeOverride
Enable this flag to override privileged mode in the batch build project.
- Returns:
- Enable this flag to override privileged mode in the batch build project.
-
buildTimeoutInMinutesOverride
Overrides the build timeout specified in the batch build project.
- Returns:
- Overrides the build timeout specified in the batch build project.
-
queuedTimeoutInMinutesOverride
The number of minutes a batch build is allowed to be queued before it times out.
- Returns:
- The number of minutes a batch build is allowed to be queued before it times out.
-
encryptionKeyOverride
The Key Management Service 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>
).- Returns:
- The Key Management Service 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>
).
-
idempotencyToken
A unique, case sensitive identifier you provide to ensure the idempotency of the
StartBuildBatch
request. The token is included in theStartBuildBatch
request and is valid for five minutes. If you repeat theStartBuildBatch
request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.- Returns:
- A unique, case sensitive identifier you provide to ensure the idempotency of the
StartBuildBatch
request. The token is included in theStartBuildBatch
request and is valid for five minutes. If you repeat theStartBuildBatch
request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
-
logsConfigOverride
A
LogsConfig
object that override the log settings defined in the batch build project.- Returns:
- A
LogsConfig
object that override the log settings defined in the batch build project.
-
registryCredentialOverride
A
RegistryCredential
object that overrides credentials for access to a private registry.- Returns:
- A
RegistryCredential
object that overrides credentials for access to a private registry.
-
imagePullCredentialsTypeOverride
The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:
- CODEBUILD
-
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
- SERVICE_ROLE
-
Specifies that 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 CodeBuild curated image, you must useCODEBUILD
credentials.If the service returns an enum value that is not available in the current SDK version,
imagePullCredentialsTypeOverride
will returnImagePullCredentialsType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimagePullCredentialsTypeOverrideAsString()
.- Returns:
- The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:
- CODEBUILD
-
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
- SERVICE_ROLE
-
Specifies that 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 CodeBuild curated image, you must useCODEBUILD
credentials. - See Also:
-
imagePullCredentialsTypeOverrideAsString
The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:
- CODEBUILD
-
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
- SERVICE_ROLE
-
Specifies that 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 CodeBuild curated image, you must useCODEBUILD
credentials.If the service returns an enum value that is not available in the current SDK version,
imagePullCredentialsTypeOverride
will returnImagePullCredentialsType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimagePullCredentialsTypeOverrideAsString()
.- Returns:
- The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:
- CODEBUILD
-
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
- SERVICE_ROLE
-
Specifies that 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 CodeBuild curated image, you must useCODEBUILD
credentials. - See Also:
-
buildBatchConfigOverride
A
BuildBatchConfigOverride
object that contains batch build configuration overrides.- Returns:
- A
BuildBatchConfigOverride
object that contains batch build configuration overrides.
-
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.
- Returns:
- 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.
-
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<StartBuildBatchRequest.Builder,
StartBuildBatchRequest> - Specified by:
toBuilder
in classCodeBuildRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-