software.amazon.awssdk.services.codebuild

Interface CodeBuildAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface CodeBuildAsyncClient
extends SdkClient, SdkAutoCloseable

Service client for accessing null asynchronously. This can be created using the static builder() method. AWS CodeBuild

AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests, and you pay only for the build time you consume. For more information about AWS CodeBuild, see the AWS CodeBuild User Guide.

AWS CodeBuild supports these operations:

• BatchDeleteBuilds: Deletes one or more builds.

• BatchGetProjects: Gets information about one or more build projects. A build project defines how AWS CodeBuild will run a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A build environment represents a combination of operating system, programming language runtime, and tools that AWS CodeBuild will use to run a build. Also, you can add tags to build projects to help manage your resources and costs.

• CreateProject: Creates a build project.

• CreateWebhook: For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.

• DeleteProject: Deletes a build project.

• DeleteWebhook: For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.

• ListProjects: Gets a list of build project names, with each build project name representing a single build project.

• UpdateProject: Changes the settings of an existing build project.

• BatchGetBuilds: Gets information about one or more builds.

• ListBuilds: Gets a list of build IDs, with each build ID representing a single build.

• ListBuildsForProject: Gets a list of build IDs for the specified build project, with each build ID representing a single build.

• StartBuild: Starts running a build.

• StopBuild: Attempts to stop running a build.

• ListCuratedEnvironmentImages: Gets information about Docker images that are managed by AWS CodeBuild.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<BatchDeleteBuildsResponse>	batchDeleteBuilds(BatchDeleteBuildsRequest batchDeleteBuildsRequest) Deletes one or more builds.
default CompletableFuture<BatchDeleteBuildsResponse>	batchDeleteBuilds(Consumer<BatchDeleteBuildsRequest.Builder> batchDeleteBuildsRequest) Deletes one or more builds.
default CompletableFuture<BatchGetBuildsResponse>	batchGetBuilds(BatchGetBuildsRequest batchGetBuildsRequest) Gets information about builds.
default CompletableFuture<BatchGetBuildsResponse>	batchGetBuilds(Consumer<BatchGetBuildsRequest.Builder> batchGetBuildsRequest) Gets information about builds.
default CompletableFuture<BatchGetProjectsResponse>	batchGetProjects(BatchGetProjectsRequest batchGetProjectsRequest) Gets information about build projects.
default CompletableFuture<BatchGetProjectsResponse>	batchGetProjects(Consumer<BatchGetProjectsRequest.Builder> batchGetProjectsRequest) Gets information about build projects.
static CodeBuildAsyncClientBuilder	builder() Create a builder that can be used to configure and create a CodeBuildAsyncClient.
static CodeBuildAsyncClient	create() Create a CodeBuildAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateProjectResponse>	createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest) Creates a build project.
default CompletableFuture<CreateProjectResponse>	createProject(CreateProjectRequest createProjectRequest) Creates a build project.
default CompletableFuture<CreateWebhookResponse>	createWebhook(Consumer<CreateWebhookRequest.Builder> createWebhookRequest) For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.
default CompletableFuture<CreateWebhookResponse>	createWebhook(CreateWebhookRequest createWebhookRequest) For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.
default CompletableFuture<DeleteProjectResponse>	deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest) Deletes a build project.
default CompletableFuture<DeleteProjectResponse>	deleteProject(DeleteProjectRequest deleteProjectRequest) Deletes a build project.
default CompletableFuture<DeleteWebhookResponse>	deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest) For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.
default CompletableFuture<DeleteWebhookResponse>	deleteWebhook(DeleteWebhookRequest deleteWebhookRequest) For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.
default CompletableFuture<ListBuildsResponse>	listBuilds() Gets a list of build IDs, with each build ID representing a single build.
default CompletableFuture<ListBuildsResponse>	listBuilds(Consumer<ListBuildsRequest.Builder> listBuildsRequest) Gets a list of build IDs, with each build ID representing a single build.
default CompletableFuture<ListBuildsResponse>	listBuilds(ListBuildsRequest listBuildsRequest) Gets a list of build IDs, with each build ID representing a single build.
default CompletableFuture<ListBuildsForProjectResponse>	listBuildsForProject(Consumer<ListBuildsForProjectRequest.Builder> listBuildsForProjectRequest) Gets a list of build IDs for the specified build project, with each build ID representing a single build.
default CompletableFuture<ListBuildsForProjectResponse>	listBuildsForProject(ListBuildsForProjectRequest listBuildsForProjectRequest) Gets a list of build IDs for the specified build project, with each build ID representing a single build.
default CompletableFuture<ListCuratedEnvironmentImagesResponse>	listCuratedEnvironmentImages() Gets information about Docker images that are managed by AWS CodeBuild.
default CompletableFuture<ListCuratedEnvironmentImagesResponse>	listCuratedEnvironmentImages(Consumer<ListCuratedEnvironmentImagesRequest.Builder> listCuratedEnvironmentImagesRequest) Gets information about Docker images that are managed by AWS CodeBuild.
default CompletableFuture<ListCuratedEnvironmentImagesResponse>	listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest) Gets information about Docker images that are managed by AWS CodeBuild.
default CompletableFuture<ListProjectsResponse>	listProjects() Gets a list of build project names, with each build project name representing a single build project.
default CompletableFuture<ListProjectsResponse>	listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest) Gets a list of build project names, with each build project name representing a single build project.
default CompletableFuture<ListProjectsResponse>	listProjects(ListProjectsRequest listProjectsRequest) Gets a list of build project names, with each build project name representing a single build project.
default CompletableFuture<StartBuildResponse>	startBuild(Consumer<StartBuildRequest.Builder> startBuildRequest) Starts running a build.
default CompletableFuture<StartBuildResponse>	startBuild(StartBuildRequest startBuildRequest) Starts running a build.
default CompletableFuture<StopBuildResponse>	stopBuild(Consumer<StopBuildRequest.Builder> stopBuildRequest) Attempts to stop running a build.
default CompletableFuture<StopBuildResponse>	stopBuild(StopBuildRequest stopBuildRequest) Attempts to stop running a build.
default CompletableFuture<UpdateProjectResponse>	updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest) Changes the settings of a build project.
default CompletableFuture<UpdateProjectResponse>	updateProject(UpdateProjectRequest updateProjectRequest) Changes the settings of a build project.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static CodeBuildAsyncClient create()

Create a CodeBuildAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CodeBuildAsyncClientBuilder builder()

Create a builder that can be used to configure and create a CodeBuildAsyncClient.

batchDeleteBuilds

default CompletableFuture<BatchDeleteBuildsResponse> batchDeleteBuilds(BatchDeleteBuildsRequest batchDeleteBuildsRequest)

Deletes one or more builds.

Parameters:

batchDeleteBuildsRequest -

Returns:

A Java Future containing the result of the BatchDeleteBuilds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

batchDeleteBuilds

default CompletableFuture<BatchDeleteBuildsResponse> batchDeleteBuilds(Consumer<BatchDeleteBuildsRequest.Builder> batchDeleteBuildsRequest)

Deletes one or more builds.

This is a convenience which creates an instance of the BatchDeleteBuildsRequest.Builder avoiding the need to create one manually via BatchDeleteBuildsRequest.builder()

Parameters:

batchDeleteBuildsRequest - a Consumer that will call methods on BatchDeleteBuildsInput.Builder.

Returns:

A Java Future containing the result of the BatchDeleteBuilds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

batchGetBuilds

default CompletableFuture<BatchGetBuildsResponse> batchGetBuilds(BatchGetBuildsRequest batchGetBuildsRequest)

Gets information about builds.

Parameters:

batchGetBuildsRequest -

Returns:

A Java Future containing the result of the BatchGetBuilds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

batchGetBuilds

default CompletableFuture<BatchGetBuildsResponse> batchGetBuilds(Consumer<BatchGetBuildsRequest.Builder> batchGetBuildsRequest)

Gets information about builds.

This is a convenience which creates an instance of the BatchGetBuildsRequest.Builder avoiding the need to create one manually via BatchGetBuildsRequest.builder()

Parameters:

batchGetBuildsRequest - a Consumer that will call methods on BatchGetBuildsInput.Builder.

Returns:

A Java Future containing the result of the BatchGetBuilds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

batchGetProjects

default CompletableFuture<BatchGetProjectsResponse> batchGetProjects(BatchGetProjectsRequest batchGetProjectsRequest)

Gets information about build projects.

Parameters:

batchGetProjectsRequest -

Returns:

A Java Future containing the result of the BatchGetProjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

batchGetProjects

default CompletableFuture<BatchGetProjectsResponse> batchGetProjects(Consumer<BatchGetProjectsRequest.Builder> batchGetProjectsRequest)

Gets information about build projects.

This is a convenience which creates an instance of the BatchGetProjectsRequest.Builder avoiding the need to create one manually via BatchGetProjectsRequest.builder()

Parameters:

batchGetProjectsRequest - a Consumer that will call methods on BatchGetProjectsInput.Builder.

Returns:

A Java Future containing the result of the BatchGetProjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createProject

default CompletableFuture<CreateProjectResponse> createProject(CreateProjectRequest createProjectRequest)

Creates a build project.

Parameters:

createProjectRequest -

Returns:

A Java Future containing the result of the CreateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• ResourceAlreadyExistsException The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.
• AccountLimitExceededException An AWS service limit was exceeded for the calling AWS account.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createProject

default CompletableFuture<CreateProjectResponse> createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)

Creates a build project.

This is a convenience which creates an instance of the CreateProjectRequest.Builder avoiding the need to create one manually via CreateProjectRequest.builder()

Parameters:

createProjectRequest - a Consumer that will call methods on CreateProjectInput.Builder.

Returns:

A Java Future containing the result of the CreateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• ResourceAlreadyExistsException The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.
• AccountLimitExceededException An AWS service limit was exceeded for the calling AWS account.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createWebhook

default CompletableFuture<CreateWebhookResponse> createWebhook(CreateWebhookRequest createWebhookRequest)

For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.

If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds will be created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you will be billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 9 in Change a Build Project’s Settings.

Parameters:

createWebhookRequest -

Returns:

A Java Future containing the result of the CreateWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• OAuthProviderException There was a problem with the underlying OAuth provider.
• ResourceAlreadyExistsException The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.
• ResourceNotFoundException The specified AWS resource cannot be found.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

createWebhook

default CompletableFuture<CreateWebhookResponse> createWebhook(Consumer<CreateWebhookRequest.Builder> createWebhookRequest)

For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.

If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds will be created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you will be billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 9 in Change a Build Project’s Settings.

This is a convenience which creates an instance of the CreateWebhookRequest.Builder avoiding the need to create one manually via CreateWebhookRequest.builder()

Parameters:

createWebhookRequest - a Consumer that will call methods on CreateWebhookInput.Builder.

Returns:

A Java Future containing the result of the CreateWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• OAuthProviderException There was a problem with the underlying OAuth provider.
• ResourceAlreadyExistsException The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.
• ResourceNotFoundException The specified AWS resource cannot be found.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteProject

default CompletableFuture<DeleteProjectResponse> deleteProject(DeleteProjectRequest deleteProjectRequest)

Deletes a build project.

Parameters:

deleteProjectRequest -

Returns:

A Java Future containing the result of the DeleteProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteProject

default CompletableFuture<DeleteProjectResponse> deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)

Deletes a build project.

This is a convenience which creates an instance of the DeleteProjectRequest.Builder avoiding the need to create one manually via DeleteProjectRequest.builder()

Parameters:

deleteProjectRequest - a Consumer that will call methods on DeleteProjectInput.Builder.

Returns:

A Java Future containing the result of the DeleteProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteWebhook

default CompletableFuture<DeleteWebhookResponse> deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)

For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.

Parameters:

deleteWebhookRequest -

Returns:

A Java Future containing the result of the DeleteWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• ResourceNotFoundException The specified AWS resource cannot be found.
• OAuthProviderException There was a problem with the underlying OAuth provider.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteWebhook

default CompletableFuture<DeleteWebhookResponse> deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest)

For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.

This is a convenience which creates an instance of the DeleteWebhookRequest.Builder avoiding the need to create one manually via DeleteWebhookRequest.builder()

Parameters:

deleteWebhookRequest - a Consumer that will call methods on DeleteWebhookInput.Builder.

Returns:

A Java Future containing the result of the DeleteWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• ResourceNotFoundException The specified AWS resource cannot be found.
• OAuthProviderException There was a problem with the underlying OAuth provider.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listBuilds

default CompletableFuture<ListBuildsResponse> listBuilds(ListBuildsRequest listBuildsRequest)

Gets a list of build IDs, with each build ID representing a single build.

Parameters:

listBuildsRequest -

Returns:

A Java Future containing the result of the ListBuilds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listBuilds

default CompletableFuture<ListBuildsResponse> listBuilds()

Gets a list of build IDs, with each build ID representing a single build.

Returns:

A Java Future containing the result of the ListBuilds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listBuilds

default CompletableFuture<ListBuildsResponse> listBuilds(Consumer<ListBuildsRequest.Builder> listBuildsRequest)

Gets a list of build IDs, with each build ID representing a single build.

This is a convenience which creates an instance of the ListBuildsRequest.Builder avoiding the need to create one manually via ListBuildsRequest.builder()

Parameters:

listBuildsRequest - a Consumer that will call methods on ListBuildsInput.Builder.

Returns:

A Java Future containing the result of the ListBuilds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listBuildsForProject

default CompletableFuture<ListBuildsForProjectResponse> listBuildsForProject(ListBuildsForProjectRequest listBuildsForProjectRequest)

Gets a list of build IDs for the specified build project, with each build ID representing a single build.

Parameters:

listBuildsForProjectRequest -

Returns:

A Java Future containing the result of the ListBuildsForProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• ResourceNotFoundException The specified AWS resource cannot be found.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listBuildsForProject

default CompletableFuture<ListBuildsForProjectResponse> listBuildsForProject(Consumer<ListBuildsForProjectRequest.Builder> listBuildsForProjectRequest)

Gets a list of build IDs for the specified build project, with each build ID representing a single build.

This is a convenience which creates an instance of the ListBuildsForProjectRequest.Builder avoiding the need to create one manually via ListBuildsForProjectRequest.builder()

Parameters:

listBuildsForProjectRequest - a Consumer that will call methods on ListBuildsForProjectInput.Builder.

Returns:

A Java Future containing the result of the ListBuildsForProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• ResourceNotFoundException The specified AWS resource cannot be found.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listCuratedEnvironmentImages

default CompletableFuture<ListCuratedEnvironmentImagesResponse> listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest)

Gets information about Docker images that are managed by AWS CodeBuild.

Parameters:

listCuratedEnvironmentImagesRequest -

Returns:

A Java Future containing the result of the ListCuratedEnvironmentImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listCuratedEnvironmentImages

default CompletableFuture<ListCuratedEnvironmentImagesResponse> listCuratedEnvironmentImages()

Gets information about Docker images that are managed by AWS CodeBuild.

Returns:

A Java Future containing the result of the ListCuratedEnvironmentImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listCuratedEnvironmentImages

default CompletableFuture<ListCuratedEnvironmentImagesResponse> listCuratedEnvironmentImages(Consumer<ListCuratedEnvironmentImagesRequest.Builder> listCuratedEnvironmentImagesRequest)

Gets information about Docker images that are managed by AWS CodeBuild.

This is a convenience which creates an instance of the ListCuratedEnvironmentImagesRequest.Builder avoiding the need to create one manually via ListCuratedEnvironmentImagesRequest.builder()

Parameters:

listCuratedEnvironmentImagesRequest - a Consumer that will call methods on ListCuratedEnvironmentImagesInput.Builder.

Returns:

A Java Future containing the result of the ListCuratedEnvironmentImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listProjects

default CompletableFuture<ListProjectsResponse> listProjects(ListProjectsRequest listProjectsRequest)

Gets a list of build project names, with each build project name representing a single build project.

Parameters:

listProjectsRequest -

Returns:

A Java Future containing the result of the ListProjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listProjects

default CompletableFuture<ListProjectsResponse> listProjects()

Gets a list of build project names, with each build project name representing a single build project.

Returns:

A Java Future containing the result of the ListProjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listProjects

default CompletableFuture<ListProjectsResponse> listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)

Gets a list of build project names, with each build project name representing a single build project.

This is a convenience which creates an instance of the ListProjectsRequest.Builder avoiding the need to create one manually via ListProjectsRequest.builder()

Parameters:

listProjectsRequest - a Consumer that will call methods on ListProjectsInput.Builder.

Returns:

A Java Future containing the result of the ListProjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

startBuild

default CompletableFuture<StartBuildResponse> startBuild(StartBuildRequest startBuildRequest)

Starts running a build.

Parameters:

startBuildRequest -

Returns:

A Java Future containing the result of the StartBuild operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• ResourceNotFoundException The specified AWS resource cannot be found.
• AccountLimitExceededException An AWS service limit was exceeded for the calling AWS account.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

startBuild

default CompletableFuture<StartBuildResponse> startBuild(Consumer<StartBuildRequest.Builder> startBuildRequest)

Starts running a build.

This is a convenience which creates an instance of the StartBuildRequest.Builder avoiding the need to create one manually via StartBuildRequest.builder()

Parameters:

startBuildRequest - a Consumer that will call methods on StartBuildInput.Builder.

Returns:

A Java Future containing the result of the StartBuild operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• ResourceNotFoundException The specified AWS resource cannot be found.
• AccountLimitExceededException An AWS service limit was exceeded for the calling AWS account.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

stopBuild

default CompletableFuture<StopBuildResponse> stopBuild(StopBuildRequest stopBuildRequest)

Attempts to stop running a build.

Parameters:

stopBuildRequest -

Returns:

A Java Future containing the result of the StopBuild operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• ResourceNotFoundException The specified AWS resource cannot be found.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

stopBuild

default CompletableFuture<StopBuildResponse> stopBuild(Consumer<StopBuildRequest.Builder> stopBuildRequest)

Attempts to stop running a build.

This is a convenience which creates an instance of the StopBuildRequest.Builder avoiding the need to create one manually via StopBuildRequest.builder()

Parameters:

stopBuildRequest - a Consumer that will call methods on StopBuildInput.Builder.

Returns:

A Java Future containing the result of the StopBuild operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• ResourceNotFoundException The specified AWS resource cannot be found.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateProject

default CompletableFuture<UpdateProjectResponse> updateProject(UpdateProjectRequest updateProjectRequest)

Changes the settings of a build project.

Parameters:

updateProjectRequest -

Returns:

A Java Future containing the result of the UpdateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• ResourceNotFoundException The specified AWS resource cannot be found.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

updateProject

default CompletableFuture<UpdateProjectResponse> updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)

Changes the settings of a build project.

This is a convenience which creates an instance of the UpdateProjectRequest.Builder avoiding the need to create one manually via UpdateProjectRequest.builder()

Parameters:

updateProjectRequest - a Consumer that will call methods on UpdateProjectInput.Builder.

Returns:

A Java Future containing the result of the UpdateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException The input value that was provided is not valid.
• ResourceNotFoundException The specified AWS resource cannot be found.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• CodeBuildException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation