StartBuildRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.codebuild.model.CodeBuildRequest
    - - software.amazon.awssdk.services.codebuild.model.StartBuildRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartBuildRequest.Builder,StartBuildRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartBuildRequest
extends CodeBuildRequest
implements ToCopyableBuilder<StartBuildRequest.Builder,StartBuildRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StartBuildRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartBuildRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 build spec declaration that overrides, for this build only, the latest one already defined in the build project.
`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.
`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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`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.
`int`	`hashCode()`
`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.
`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 AWS 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.
`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()` A 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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - projectName
```
public String projectName()
```
    The name of the AWS CodeBuild build project to start running a build.
    
    Returns:
    
    The name of the AWS CodeBuild build project to start running a build.
  - secondarySourcesOverride
```
public List<ProjectSource> secondarySourcesOverride()
```
    An array of ProjectSource objects.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    An array of ProjectSource objects.
  - secondarySourcesVersionOverride
```
public 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.
    
    Returns:
    
    An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.
  - sourceVersion
```
public 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.
    Returns:
    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.
  - artifactsOverride
```
public ProjectArtifacts artifactsOverride()
```
    Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
    
    Returns:
    
    Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
  - secondaryArtifactsOverride
```
public List<ProjectArtifacts> secondaryArtifactsOverride()
```
    An array of ProjectArtifacts objects.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    An array of ProjectArtifacts objects.
  - environmentVariablesOverride
```
public 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.
    
    Returns:
    
    A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
  - sourceTypeOverride
```
public 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().
    
    Returns:
    
    A source input type, for this build, that overrides the source input defined in the build project.
    
    See Also:
    
    SourceType
  - sourceTypeOverrideAsString
```
public 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().
    
    Returns:
    
    A source input type, for this build, that overrides the source input defined in the build project.
    
    See Also:
    
    SourceType
  - sourceLocationOverride
```
public String sourceLocationOverride()
```
    A location that overrides, for this build, the source location for the one defined in the build project.
    
    Returns:
    
    A location that overrides, for this build, the source location for the one defined in the build project.
  - sourceAuthOverride
```
public 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.
    
    Returns:
    
    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.
  - gitCloneDepthOverride
```
public 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.
    
    Returns:
    
    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.
  - buildspecOverride
```
public String buildspecOverride()
```
    A build spec declaration that overrides, for this build only, the latest one already defined in the build project.
    
    Returns:
    
    A build spec declaration that overrides, for this build only, the latest one already defined in the build project.
  - insecureSslOverride
```
public 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.
    
    Returns:
    
    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.
  - reportBuildStatusOverride
```
public 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.
    
    Returns:
    
    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.
  - environmentTypeOverride
```
public 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().
    
    Returns:
    
    A container type for this build that overrides the one specified in the build project.
    
    See Also:
    
    EnvironmentType
  - environmentTypeOverrideAsString
```
public 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().
    
    Returns:
    
    A container type for this build that overrides the one specified in the build project.
    
    See Also:
    
    EnvironmentType
  - imageOverride
```
public String imageOverride()
```
    The name of an image for this build that overrides the one specified in the build project.
    
    Returns:
    
    The name of an image for this build that overrides the one specified in the build project.
  - computeTypeOverride
```
public 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().
    
    Returns:
    
    The name of a compute type for this build that overrides the one specified in the build project.
    
    See Also:
    
    ComputeType
  - computeTypeOverrideAsString
```
public 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().
    
    Returns:
    
    The name of a compute type for this build that overrides the one specified in the build project.
    
    See Also:
    
    ComputeType
  - certificateOverride
```
public String certificateOverride()
```
    The name of a certificate for this build that overrides the one specified in the build project.
    
    Returns:
    
    The name of a certificate for this build that overrides the one specified in the build project.
  - cacheOverride
```
public ProjectCache cacheOverride()
```
    A ProjectCache object specified for this build that overrides the one defined in the build project.
    
    Returns:
    
    A ProjectCache object specified for this build that overrides the one defined in the build project.
  - serviceRoleOverride
```
public String serviceRoleOverride()
```
    The name of a service role for this build that overrides the one specified in the build project.
    
    Returns:
    
    The name of a service role for this build that overrides the one specified in the build project.
  - privilegedModeOverride
```
public Boolean privilegedModeOverride()
```
    Enable this flag to override privileged mode in the build project.
    
    Returns:
    
    Enable this flag to override privileged mode in the build project.
  - timeoutInMinutesOverride
```
public 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.
    
    Returns:
    
    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.
  - queuedTimeoutInMinutesOverride
```
public Integer queuedTimeoutInMinutesOverride()
```
    The number of minutes a build is allowed to be queued before it times out.
    
    Returns:
    
    The number of minutes a build is allowed to be queued before it times out.
  - idempotencyToken
```
public 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.
    
    Returns:
    
    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.
  - logsConfigOverride
```
public LogsConfig logsConfigOverride()
```
    Log settings for this build that override the log settings defined in the build project.
    
    Returns:
    
    Log settings for this build that override the log settings defined in the build project.
  - toBuilder
```
public StartBuildRequest.Builder 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 interface ToCopyableBuilder<StartBuildRequest.Builder,StartBuildRequest>
    
    Specified by:
    
    toBuilder in class CodeBuildRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static StartBuildRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartBuildRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    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
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class StartBuildRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

projectName

secondarySourcesOverride

secondarySourcesVersionOverride

sourceVersion

artifactsOverride

secondaryArtifactsOverride

environmentVariablesOverride

sourceTypeOverride

sourceTypeOverrideAsString

sourceLocationOverride

sourceAuthOverride

gitCloneDepthOverride

buildspecOverride

insecureSslOverride

reportBuildStatusOverride

environmentTypeOverride

environmentTypeOverrideAsString

imageOverride

computeTypeOverride

computeTypeOverrideAsString

certificateOverride

cacheOverride

serviceRoleOverride

privilegedModeOverride

timeoutInMinutesOverride

queuedTimeoutInMinutesOverride

idempotencyToken

logsConfigOverride

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields