Package software.amazon.awssdk.services.codebuild

Interface CodeBuildAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface CodeBuildAsyncClient
extends AutoCloseable

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 Apach 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:

• 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.

• DeleteProject: Deletes a build project.

• 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.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<BatchGetBuildsResponse>	batchGetBuilds(BatchGetBuildsRequest batchGetBuildsRequest)	Gets information about builds.
default CompletableFuture<BatchGetProjectsResponse>	batchGetProjects(BatchGetProjectsRequest 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(CreateProjectRequest createProjectRequest)	Creates a build project.
default CompletableFuture<DeleteProjectResponse>	deleteProject(DeleteProjectRequest deleteProjectRequest)	Deletes a build project.
default CompletableFuture<ListBuildsResponse>	listBuilds(ListBuildsRequest listBuildsRequest)	Gets a list of build IDs, 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(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest)	Gets information about Docker images that are managed by AWS CodeBuild.
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(StartBuildRequest startBuildRequest)	Starts running a build.
default CompletableFuture<StopBuildResponse>	stopBuild(StopBuildRequest stopBuildRequest)	Attempts to stop running a build.
default CompletableFuture<UpdateProjectResponse>	updateProject(UpdateProjectRequest updateProjectRequest)	Changes the settings of a build project.

Methods inherited from interface java.lang.AutoCloseable

close

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.

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.
• SdkBaseException 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

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.
• SdkBaseException 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

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.
• SdkBaseException 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

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.
• SdkBaseException 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

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.
• SdkBaseException 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

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.
• SdkBaseException 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

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.

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.
• SdkBaseException 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

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.
• SdkBaseException 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

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.
• SdkBaseException 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

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.
• SdkBaseException 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

See Also:

AWS API Documentation