@Generated(value="software.amazon.awssdk:codegen") public final class StartBuildRequest extends CodeBuildRequest implements ToCopyableBuilder<StartBuildRequest.Builder,StartBuildRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
StartBuildRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
ProjectArtifacts |
artifactsOverride()
Build output artifact settings that override, for this build only, the latest ones already defined in the build
project.
|
static StartBuildRequest.Builder |
builder() |
String |
buildspecOverride()
A buildspec file declaration that overrides, for this build only, the latest one already defined in the build
project.
|
BuildStatusConfig |
buildStatusConfigOverride()
Contains information that defines how the build project reports the build status to the source provider.
|
ProjectCache |
cacheOverride()
A ProjectCache object specified for this build that overrides the one defined in the build project.
|
String |
certificateOverride()
The name of a certificate for this build that overrides the one specified in the build project.
|
ComputeType |
computeTypeOverride()
The name of a compute type for this build that overrides the one specified in the build project.
|
String |
computeTypeOverrideAsString()
The name of a compute type for this build that overrides the one specified in the build project.
|
Boolean |
debugSessionEnabled()
Specifies if session debugging is enabled for this build.
|
String |
encryptionKeyOverride()
The Key Management Service customer master key (CMK) that overrides the one specified in the build project.
|
EnvironmentType |
environmentTypeOverride()
A container type for this build that overrides the one specified in the build project.
|
String |
environmentTypeOverrideAsString()
A container type for this build that overrides the one specified in the build project.
|
List<EnvironmentVariable> |
environmentVariablesOverride()
A set of environment variables that overrides, for this build only, the latest ones already defined in the 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 build only, any previous
depth of history defined in the build project.
|
GitSubmodulesConfig |
gitSubmodulesConfigOverride()
Information about the Git submodules configuration for this build of an CodeBuild build project.
|
boolean |
hasEnvironmentVariablesOverride()
For responses, this returns true if the service returned a value for the EnvironmentVariablesOverride property.
|
int |
hashCode() |
boolean |
hasSecondaryArtifactsOverride()
For responses, this returns true if the service returned a value for the SecondaryArtifactsOverride property.
|
boolean |
hasSecondarySourcesOverride()
For responses, this returns true if the service returned a value for the SecondarySourcesOverride property.
|
boolean |
hasSecondarySourcesVersionOverride()
For responses, this returns true if the service returned a value for the SecondarySourcesVersionOverride
property.
|
String |
idempotencyToken()
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request.
|
String |
imageOverride()
The name of an image for this build that overrides the one specified in the build project.
|
ImagePullCredentialsType |
imagePullCredentialsTypeOverride()
The type of credentials CodeBuild uses to pull images in your build.
|
String |
imagePullCredentialsTypeOverrideAsString()
The type of credentials CodeBuild uses to pull images in your build.
|
Boolean |
insecureSslOverride()
Enable this flag to override the insecure SSL setting that is specified in the build project.
|
LogsConfig |
logsConfigOverride()
Log settings for this build that override the log settings defined in the build project.
|
Boolean |
privilegedModeOverride()
Enable this flag to override privileged mode in the build project.
|
String |
projectName()
The name of the CodeBuild build project to start running a build.
|
Integer |
queuedTimeoutInMinutesOverride()
The number of minutes a build is allowed to be queued before it times out.
|
RegistryCredential |
registryCredentialOverride()
The credentials for access to a private registry.
|
Boolean |
reportBuildStatusOverride()
Set to true to report to your source provider the status of a build's start and completion.
|
List<SdkField<?>> |
sdkFields() |
List<ProjectArtifacts> |
secondaryArtifactsOverride()
An array of
ProjectArtifacts objects. |
List<ProjectSource> |
secondarySourcesOverride()
An array of
ProjectSource objects. |
List<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. |
static Class<? extends StartBuildRequest.Builder> |
serializableBuilderClass() |
String |
serviceRoleOverride()
The name of a service role for this build that overrides the one specified in the build project.
|
SourceAuth |
sourceAuthOverride()
An authorization type for this build that overrides the one defined in the build project.
|
String |
sourceLocationOverride()
A location that overrides, for this build, the source location for the one defined in the build project.
|
SourceType |
sourceTypeOverride()
A source input type, for this build, that overrides the source input defined in the build project.
|
String |
sourceTypeOverrideAsString()
A source input type, for this build, that overrides the source input defined in the build project.
|
String |
sourceVersion()
The version of the build input to be built, for this build only.
|
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.
|
StartBuildRequest.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 CodeBuild build project to start running a build.
public final boolean hasSecondarySourcesOverride()
isEmpty() 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.public final List<ProjectSource> secondarySourcesOverride()
An array of ProjectSource objects.
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.
ProjectSource objects.public final boolean hasSecondarySourcesVersionOverride()
isEmpty()
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.public final List<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.
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.
ProjectSourceVersion objects that specify one or more versions of the project's
secondary sources to be used for this build only.public final String sourceVersion()
The version of the 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 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 CodeBuild User Guide.
public final ProjectArtifacts artifactsOverride()
Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
public final boolean hasSecondaryArtifactsOverride()
isEmpty() 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.public final List<ProjectArtifacts> secondaryArtifactsOverride()
An array of ProjectArtifacts objects.
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.
ProjectArtifacts objects.public final boolean hasEnvironmentVariablesOverride()
isEmpty() 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.public final List<EnvironmentVariable> environmentVariablesOverride()
A set of environment variables that overrides, for this build only, the latest ones already defined in the 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.
public final SourceType sourceTypeOverride()
A source input type, for this build, that overrides the source input defined in the 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()
A source input type, for this build, that overrides the source input defined in the 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 build, the source location for the one defined in the build project.
public final 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.
public final 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.
public final GitSubmodulesConfig gitSubmodulesConfigOverride()
Information about the Git submodules configuration for this build of an CodeBuild build project.
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 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.
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.
public final 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.
public final 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.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
invalidInputException is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
public final BuildStatusConfig buildStatusConfigOverride()
Contains information that defines how the build project reports the build status to the source provider. This
option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or
BITBUCKET.
GITHUB, GITHUB_ENTERPRISE,
or BITBUCKET.public final EnvironmentType environmentTypeOverride()
A container type for this build that overrides the one specified in the 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 build that overrides the one specified in the 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 build that overrides the one specified in the build project.
public final ComputeType computeTypeOverride()
The name of a compute type for this build that overrides the one specified in the 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 build that overrides the one specified in the 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 build that overrides the one specified in the build project.
public final ProjectCache cacheOverride()
A ProjectCache object specified for this build that overrides the one defined in the build project.
public final String serviceRoleOverride()
The name of a service role for this build that overrides the one specified in the build project.
public final Boolean privilegedModeOverride()
Enable this flag to override privileged mode in the build project.
public final 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.
public final Integer queuedTimeoutInMinutesOverride()
The number of minutes a build is allowed to be queued before it times out.
public final String encryptionKeyOverride()
The Key Management Service customer master key (CMK) that overrides the one specified in the 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 StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
public final LogsConfig logsConfigOverride()
Log settings for this build that override the log settings defined in the build project.
public final RegistryCredential registryCredentialOverride()
The credentials for access to a private registry.
public final ImagePullCredentialsType imagePullCredentialsTypeOverride()
The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
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 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 CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
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 use CODEBUILD credentials.
ImagePullCredentialsTypepublic final String imagePullCredentialsTypeOverrideAsString()
The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
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 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 CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
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 use CODEBUILD credentials.
ImagePullCredentialsTypepublic final Boolean debugSessionEnabled()
Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.
public StartBuildRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<StartBuildRequest.Builder,StartBuildRequest>toBuilder in class CodeBuildRequestpublic static StartBuildRequest.Builder builder()
public static Class<? extends StartBuildRequest.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 © 2023. All rights reserved.