public static interface StartBuildRequest.Builder extends CodeBuildRequest.Builder, SdkPojo, CopyableBuilder<StartBuildRequest.Builder,StartBuildRequest>
Modifier and Type | Method and Description |
---|---|
default StartBuildRequest.Builder |
artifactsOverride(Consumer<ProjectArtifacts.Builder> artifactsOverride)
Build output artifact settings that override, for this build only, the latest ones already defined in the
build project.
|
StartBuildRequest.Builder |
artifactsOverride(ProjectArtifacts artifactsOverride)
Build output artifact settings that override, for this build only, the latest ones already defined in the
build project.
|
StartBuildRequest.Builder |
buildspecOverride(String buildspecOverride)
A build spec declaration that overrides, for this build only, the latest one already defined in the build
project.
|
default StartBuildRequest.Builder |
cacheOverride(Consumer<ProjectCache.Builder> cacheOverride)
A ProjectCache object specified for this build that overrides the one defined in the build project.
|
StartBuildRequest.Builder |
cacheOverride(ProjectCache cacheOverride)
A ProjectCache object specified for this build that overrides the one defined in the build project.
|
StartBuildRequest.Builder |
certificateOverride(String certificateOverride)
The name of a certificate for this build that overrides the one specified in the build project.
|
StartBuildRequest.Builder |
computeTypeOverride(ComputeType computeTypeOverride)
The name of a compute type for this build that overrides the one specified in the build project.
|
StartBuildRequest.Builder |
computeTypeOverride(String computeTypeOverride)
The name of a compute type for this build that overrides the one specified in the build project.
|
StartBuildRequest.Builder |
environmentTypeOverride(EnvironmentType environmentTypeOverride)
A container type for this build that overrides the one specified in the build project.
|
StartBuildRequest.Builder |
environmentTypeOverride(String environmentTypeOverride)
A container type for this build that overrides the one specified in the build project.
|
StartBuildRequest.Builder |
environmentVariablesOverride(Collection<EnvironmentVariable> environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the
build project.
|
StartBuildRequest.Builder |
environmentVariablesOverride(Consumer<EnvironmentVariable.Builder>... environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the
build project.
|
StartBuildRequest.Builder |
environmentVariablesOverride(EnvironmentVariable... environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the
build project.
|
StartBuildRequest.Builder |
gitCloneDepthOverride(Integer gitCloneDepthOverride)
The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any
previous depth of history defined in the build project.
|
StartBuildRequest.Builder |
idempotencyToken(String idempotencyToken)
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request.
|
StartBuildRequest.Builder |
imageOverride(String imageOverride)
The name of an image for this build that overrides the one specified in the build project.
|
StartBuildRequest.Builder |
insecureSslOverride(Boolean insecureSslOverride)
Enable this flag to override the insecure SSL setting that is specified in the build project.
|
default StartBuildRequest.Builder |
logsConfigOverride(Consumer<LogsConfig.Builder> logsConfigOverride)
Log settings for this build that override the log settings defined in the build project.
|
StartBuildRequest.Builder |
logsConfigOverride(LogsConfig logsConfigOverride)
Log settings for this build that override the log settings defined in the build project.
|
StartBuildRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
StartBuildRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
StartBuildRequest.Builder |
privilegedModeOverride(Boolean privilegedModeOverride)
Enable this flag to override privileged mode in the build project.
|
StartBuildRequest.Builder |
projectName(String projectName)
The name of the AWS CodeBuild build project to start running a build.
|
StartBuildRequest.Builder |
queuedTimeoutInMinutesOverride(Integer queuedTimeoutInMinutesOverride)
The number of minutes a build is allowed to be queued before it times out.
|
StartBuildRequest.Builder |
reportBuildStatusOverride(Boolean reportBuildStatusOverride)
Set to true to report to your source provider the status of a build's start and completion.
|
StartBuildRequest.Builder |
secondaryArtifactsOverride(Collection<ProjectArtifacts> secondaryArtifactsOverride)
An array of
ProjectArtifacts objects. |
StartBuildRequest.Builder |
secondaryArtifactsOverride(Consumer<ProjectArtifacts.Builder>... secondaryArtifactsOverride)
An array of
ProjectArtifacts objects. |
StartBuildRequest.Builder |
secondaryArtifactsOverride(ProjectArtifacts... secondaryArtifactsOverride)
An array of
ProjectArtifacts objects. |
StartBuildRequest.Builder |
secondarySourcesOverride(Collection<ProjectSource> secondarySourcesOverride)
An array of
ProjectSource objects. |
StartBuildRequest.Builder |
secondarySourcesOverride(Consumer<ProjectSource.Builder>... secondarySourcesOverride)
An array of
ProjectSource objects. |
StartBuildRequest.Builder |
secondarySourcesOverride(ProjectSource... secondarySourcesOverride)
An array of
ProjectSource objects. |
StartBuildRequest.Builder |
secondarySourcesVersionOverride(Collection<ProjectSourceVersion> secondarySourcesVersionOverride)
An array of
ProjectSourceVersion objects that specify one or more versions of the project's
secondary sources to be used for this build only. |
StartBuildRequest.Builder |
secondarySourcesVersionOverride(Consumer<ProjectSourceVersion.Builder>... secondarySourcesVersionOverride)
An array of
ProjectSourceVersion objects that specify one or more versions of the project's
secondary sources to be used for this build only. |
StartBuildRequest.Builder |
secondarySourcesVersionOverride(ProjectSourceVersion... secondarySourcesVersionOverride)
An array of
ProjectSourceVersion objects that specify one or more versions of the project's
secondary sources to be used for this build only. |
StartBuildRequest.Builder |
serviceRoleOverride(String serviceRoleOverride)
The name of a service role for this build that overrides the one specified in the build project.
|
default StartBuildRequest.Builder |
sourceAuthOverride(Consumer<SourceAuth.Builder> sourceAuthOverride)
An authorization type for this build that overrides the one defined in the build project.
|
StartBuildRequest.Builder |
sourceAuthOverride(SourceAuth sourceAuthOverride)
An authorization type for this build that overrides the one defined in the build project.
|
StartBuildRequest.Builder |
sourceLocationOverride(String sourceLocationOverride)
A location that overrides, for this build, the source location for the one defined in the build project.
|
StartBuildRequest.Builder |
sourceTypeOverride(SourceType sourceTypeOverride)
A source input type, for this build, that overrides the source input defined in the build project.
|
StartBuildRequest.Builder |
sourceTypeOverride(String sourceTypeOverride)
A source input type, for this build, that overrides the source input defined in the build project.
|
StartBuildRequest.Builder |
sourceVersion(String sourceVersion)
A version of the build input to be built, for this build only.
|
StartBuildRequest.Builder |
timeoutInMinutesOverride(Integer timeoutInMinutesOverride)
The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest
setting already defined in the build project.
|
build
overrideConfiguration
copy
applyMutation, build
StartBuildRequest.Builder projectName(String projectName)
The name of the AWS CodeBuild build project to start running a build.
projectName
- The name of the AWS CodeBuild build project to start running a build.StartBuildRequest.Builder secondarySourcesOverride(Collection<ProjectSource> secondarySourcesOverride)
An array of ProjectSource
objects.
secondarySourcesOverride
- An array of ProjectSource
objects.StartBuildRequest.Builder secondarySourcesOverride(ProjectSource... secondarySourcesOverride)
An array of ProjectSource
objects.
secondarySourcesOverride
- An array of ProjectSource
objects.StartBuildRequest.Builder secondarySourcesOverride(Consumer<ProjectSource.Builder>... secondarySourcesOverride)
An array of ProjectSource
objects.
List.Builder
avoiding the need
to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #secondarySourcesOverride(List)
.secondarySourcesOverride
- a consumer that will call methods on List.Builder
#secondarySourcesOverride(List)
StartBuildRequest.Builder secondarySourcesVersionOverride(Collection<ProjectSourceVersion> secondarySourcesVersionOverride)
An array of ProjectSourceVersion
objects that specify one or more versions of the project's
secondary sources to be used for this build only.
secondarySourcesVersionOverride
- An array of ProjectSourceVersion
objects that specify one or more versions of the
project's secondary sources to be used for this build only.StartBuildRequest.Builder secondarySourcesVersionOverride(ProjectSourceVersion... secondarySourcesVersionOverride)
An array of ProjectSourceVersion
objects that specify one or more versions of the project's
secondary sources to be used for this build only.
secondarySourcesVersionOverride
- An array of ProjectSourceVersion
objects that specify one or more versions of the
project's secondary sources to be used for this build only.StartBuildRequest.Builder secondarySourcesVersionOverride(Consumer<ProjectSourceVersion.Builder>... secondarySourcesVersionOverride)
An array of ProjectSourceVersion
objects that specify one or more versions of the project's
secondary sources to be used for this build only.
List.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately
and its result is passed to #secondarySourcesVersionOverride(List)
.secondarySourcesVersionOverride
- a consumer that will call methods on List.Builder
#secondarySourcesVersionOverride(List)
StartBuildRequest.Builder sourceVersion(String sourceVersion)
A version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, 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.
sourceVersion
- A version of the build input to be built, for this build only. If not specified, the latest version is
used. If specified, 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.
StartBuildRequest.Builder artifactsOverride(ProjectArtifacts artifactsOverride)
Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
artifactsOverride
- Build output artifact settings that override, for this build only, the latest ones already defined in
the build project.default StartBuildRequest.Builder artifactsOverride(Consumer<ProjectArtifacts.Builder> artifactsOverride)
Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
This is a convenience that creates an instance of theProjectArtifacts.Builder
avoiding the need to
create one manually via ProjectArtifacts.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to artifactsOverride(ProjectArtifacts)
.artifactsOverride
- a consumer that will call methods on ProjectArtifacts.Builder
artifactsOverride(ProjectArtifacts)
StartBuildRequest.Builder secondaryArtifactsOverride(Collection<ProjectArtifacts> secondaryArtifactsOverride)
An array of ProjectArtifacts
objects.
secondaryArtifactsOverride
- An array of ProjectArtifacts
objects.StartBuildRequest.Builder secondaryArtifactsOverride(ProjectArtifacts... secondaryArtifactsOverride)
An array of ProjectArtifacts
objects.
secondaryArtifactsOverride
- An array of ProjectArtifacts
objects.StartBuildRequest.Builder secondaryArtifactsOverride(Consumer<ProjectArtifacts.Builder>... secondaryArtifactsOverride)
An array of ProjectArtifacts
objects.
List.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #secondaryArtifactsOverride(List)
.secondaryArtifactsOverride
- a consumer that will call methods on List.Builder
#secondaryArtifactsOverride(List)
StartBuildRequest.Builder environmentVariablesOverride(Collection<EnvironmentVariable> environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
environmentVariablesOverride
- A set of environment variables that overrides, for this build only, the latest ones already defined in
the build project.StartBuildRequest.Builder environmentVariablesOverride(EnvironmentVariable... environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
environmentVariablesOverride
- A set of environment variables that overrides, for this build only, the latest ones already defined in
the build project.StartBuildRequest.Builder environmentVariablesOverride(Consumer<EnvironmentVariable.Builder>... environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
This is a convenience that creates an instance of theList.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately
and its result is passed to #environmentVariablesOverride(List)
.environmentVariablesOverride
- a consumer that will call methods on List.Builder
#environmentVariablesOverride(List)
StartBuildRequest.Builder sourceTypeOverride(String sourceTypeOverride)
A source input type, for this build, that overrides the source input defined in the build project.
sourceTypeOverride
- A source input type, for this build, that overrides the source input defined in the build project.SourceType
,
SourceType
StartBuildRequest.Builder sourceTypeOverride(SourceType sourceTypeOverride)
A source input type, for this build, that overrides the source input defined in the build project.
sourceTypeOverride
- A source input type, for this build, that overrides the source input defined in the build project.SourceType
,
SourceType
StartBuildRequest.Builder sourceLocationOverride(String sourceLocationOverride)
A location that overrides, for this build, the source location for the one defined in the build project.
sourceLocationOverride
- A location that overrides, for this build, the source location for the one defined in the build
project.StartBuildRequest.Builder sourceAuthOverride(SourceAuth sourceAuthOverride)
An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.
sourceAuthOverride
- An authorization type for this build that overrides the one defined in the build project. This
override applies only if the build project's source is BitBucket or GitHub.default StartBuildRequest.Builder sourceAuthOverride(Consumer<SourceAuth.Builder> sourceAuthOverride)
An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.
This is a convenience that creates an instance of theSourceAuth.Builder
avoiding the need to create
one manually via SourceAuth.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result
is passed to sourceAuthOverride(SourceAuth)
.sourceAuthOverride
- a consumer that will call methods on SourceAuth.Builder
sourceAuthOverride(SourceAuth)
StartBuildRequest.Builder gitCloneDepthOverride(Integer gitCloneDepthOverride)
The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.
gitCloneDepthOverride
- The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any
previous depth of history defined in the build project.StartBuildRequest.Builder buildspecOverride(String buildspecOverride)
A build spec declaration that overrides, for this build only, the latest one already defined in the build project.
buildspecOverride
- A build spec declaration that overrides, for this build only, the latest one already defined in the
build project.StartBuildRequest.Builder insecureSslOverride(Boolean insecureSslOverride)
Enable this flag to override the insecure SSL setting that is specified in the 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.
insecureSslOverride
- Enable this flag to override the insecure SSL setting that is specified in the 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.StartBuildRequest.Builder reportBuildStatusOverride(Boolean reportBuildStatusOverride)
Set to true to report to your source provider the status of a 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.
reportBuildStatusOverride
- Set to true to report to your source provider the status of a 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.StartBuildRequest.Builder environmentTypeOverride(String environmentTypeOverride)
A container type for this build that overrides the one specified in the build project.
environmentTypeOverride
- A container type for this build that overrides the one specified in the build project.EnvironmentType
,
EnvironmentType
StartBuildRequest.Builder environmentTypeOverride(EnvironmentType environmentTypeOverride)
A container type for this build that overrides the one specified in the build project.
environmentTypeOverride
- A container type for this build that overrides the one specified in the build project.EnvironmentType
,
EnvironmentType
StartBuildRequest.Builder imageOverride(String imageOverride)
The name of an image for this build that overrides the one specified in the build project.
imageOverride
- The name of an image for this build that overrides the one specified in the build project.StartBuildRequest.Builder computeTypeOverride(String computeTypeOverride)
The name of a compute type for this build that overrides the one specified in the build project.
computeTypeOverride
- The name of a compute type for this build that overrides the one specified in the build project.ComputeType
,
ComputeType
StartBuildRequest.Builder computeTypeOverride(ComputeType computeTypeOverride)
The name of a compute type for this build that overrides the one specified in the build project.
computeTypeOverride
- The name of a compute type for this build that overrides the one specified in the build project.ComputeType
,
ComputeType
StartBuildRequest.Builder certificateOverride(String certificateOverride)
The name of a certificate for this build that overrides the one specified in the build project.
certificateOverride
- The name of a certificate for this build that overrides the one specified in the build project.StartBuildRequest.Builder cacheOverride(ProjectCache cacheOverride)
A ProjectCache object specified for this build that overrides the one defined in the build project.
cacheOverride
- A ProjectCache object specified for this build that overrides the one defined in the build project.default StartBuildRequest.Builder cacheOverride(Consumer<ProjectCache.Builder> cacheOverride)
A ProjectCache object specified for this build that overrides the one defined in the build project.
This is a convenience that creates an instance of theProjectCache.Builder
avoiding the need to
create one manually via ProjectCache.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to cacheOverride(ProjectCache)
.cacheOverride
- a consumer that will call methods on ProjectCache.Builder
cacheOverride(ProjectCache)
StartBuildRequest.Builder serviceRoleOverride(String serviceRoleOverride)
The name of a service role for this build that overrides the one specified in the build project.
serviceRoleOverride
- The name of a service role for this build that overrides the one specified in the build project.StartBuildRequest.Builder privilegedModeOverride(Boolean privilegedModeOverride)
Enable this flag to override privileged mode in the build project.
privilegedModeOverride
- Enable this flag to override privileged mode in the build project.StartBuildRequest.Builder timeoutInMinutesOverride(Integer timeoutInMinutesOverride)
The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.
timeoutInMinutesOverride
- The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the
latest setting already defined in the build project.StartBuildRequest.Builder queuedTimeoutInMinutesOverride(Integer queuedTimeoutInMinutesOverride)
The number of minutes a build is allowed to be queued before it times out.
queuedTimeoutInMinutesOverride
- The number of minutes a build is allowed to be queued before it times out.StartBuildRequest.Builder idempotencyToken(String idempotencyToken)
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.
idempotencyToken
- A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request.
The token is included in the StartBuild request and is valid for 12 hours. If you repeat the
StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter
mismatch error.StartBuildRequest.Builder logsConfigOverride(LogsConfig logsConfigOverride)
Log settings for this build that override the log settings defined in the build project.
logsConfigOverride
- Log settings for this build that override the log settings defined in the build project.default StartBuildRequest.Builder logsConfigOverride(Consumer<LogsConfig.Builder> logsConfigOverride)
Log settings for this build that override the log settings defined in the build project.
This is a convenience that creates an instance of theLogsConfig.Builder
avoiding the need to create
one manually via LogsConfig.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result
is passed to logsConfigOverride(LogsConfig)
.logsConfigOverride
- a consumer that will call methods on LogsConfig.Builder
logsConfigOverride(LogsConfig)
StartBuildRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.StartBuildRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.