software.amazon.awssdk.services.codebuild.model

Class StartBuildRequest

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:

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

Method Summary

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.
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.
int	hashCode()
String	projectName() The name of the build project to start running a build.
static Class<? extends StartBuildRequest.Builder>	serializableBuilderClass()
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 build project to start running a build.

Returns:

The name of the build project to start running a build.

sourceVersion

public String sourceVersion()

A version of the build input to be built, for this build only. If not specified, the latest version will be 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 will be used. If not specified, the default branch's HEAD commit ID will be 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 will be used. If not specified, the default branch's HEAD commit ID will be used.

• For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing 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 will be 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 will be used. If not specified, the default branch's HEAD commit ID will be 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 will be used. If not specified, the default branch's HEAD commit ID will be used.

• For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing 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.

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.

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.

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.

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