com.amazonaws.services.codebuild

Interface AWSCodeBuildAsync

All Superinterfaces:

AWSCodeBuild

All Known Implementing Classes:

AbstractAWSCodeBuildAsync, AWSCodeBuildAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCodeBuildAsync
extends AWSCodeBuild

Interface for accessing AWS CodeBuild asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCodeBuildAsync instead.

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 inherited from interface com.amazonaws.services.codebuild.AWSCodeBuild

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<BatchDeleteBuildsResult>	batchDeleteBuildsAsync(BatchDeleteBuildsRequest batchDeleteBuildsRequest) Deletes one or more builds.
Future<BatchDeleteBuildsResult>	batchDeleteBuildsAsync(BatchDeleteBuildsRequest batchDeleteBuildsRequest, AsyncHandler<BatchDeleteBuildsRequest,BatchDeleteBuildsResult> asyncHandler) Deletes one or more builds.
Future<BatchGetBuildsResult>	batchGetBuildsAsync(BatchGetBuildsRequest batchGetBuildsRequest) Gets information about builds.
Future<BatchGetBuildsResult>	batchGetBuildsAsync(BatchGetBuildsRequest batchGetBuildsRequest, AsyncHandler<BatchGetBuildsRequest,BatchGetBuildsResult> asyncHandler) Gets information about builds.
Future<BatchGetProjectsResult>	batchGetProjectsAsync(BatchGetProjectsRequest batchGetProjectsRequest) Gets information about build projects.
Future<BatchGetProjectsResult>	batchGetProjectsAsync(BatchGetProjectsRequest batchGetProjectsRequest, AsyncHandler<BatchGetProjectsRequest,BatchGetProjectsResult> asyncHandler) Gets information about build projects.
Future<CreateProjectResult>	createProjectAsync(CreateProjectRequest createProjectRequest) Creates a build project.
Future<CreateProjectResult>	createProjectAsync(CreateProjectRequest createProjectRequest, AsyncHandler<CreateProjectRequest,CreateProjectResult> asyncHandler) Creates a build project.
Future<CreateWebhookResult>	createWebhookAsync(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.
Future<CreateWebhookResult>	createWebhookAsync(CreateWebhookRequest createWebhookRequest, AsyncHandler<CreateWebhookRequest,CreateWebhookResult> asyncHandler) 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.
Future<DeleteProjectResult>	deleteProjectAsync(DeleteProjectRequest deleteProjectRequest) Deletes a build project.
Future<DeleteProjectResult>	deleteProjectAsync(DeleteProjectRequest deleteProjectRequest, AsyncHandler<DeleteProjectRequest,DeleteProjectResult> asyncHandler) Deletes a build project.
Future<DeleteWebhookResult>	deleteWebhookAsync(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.
Future<DeleteWebhookResult>	deleteWebhookAsync(DeleteWebhookRequest deleteWebhookRequest, AsyncHandler<DeleteWebhookRequest,DeleteWebhookResult> asyncHandler) 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.
Future<ListBuildsResult>	listBuildsAsync(ListBuildsRequest listBuildsRequest) Gets a list of build IDs, with each build ID representing a single build.
Future<ListBuildsResult>	listBuildsAsync(ListBuildsRequest listBuildsRequest, AsyncHandler<ListBuildsRequest,ListBuildsResult> asyncHandler) Gets a list of build IDs, with each build ID representing a single build.
Future<ListBuildsForProjectResult>	listBuildsForProjectAsync(ListBuildsForProjectRequest listBuildsForProjectRequest) Gets a list of build IDs for the specified build project, with each build ID representing a single build.
Future<ListBuildsForProjectResult>	listBuildsForProjectAsync(ListBuildsForProjectRequest listBuildsForProjectRequest, AsyncHandler<ListBuildsForProjectRequest,ListBuildsForProjectResult> asyncHandler) Gets a list of build IDs for the specified build project, with each build ID representing a single build.
Future<ListCuratedEnvironmentImagesResult>	listCuratedEnvironmentImagesAsync(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest) Gets information about Docker images that are managed by AWS CodeBuild.
Future<ListCuratedEnvironmentImagesResult>	listCuratedEnvironmentImagesAsync(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest, AsyncHandler<ListCuratedEnvironmentImagesRequest,ListCuratedEnvironmentImagesResult> asyncHandler) Gets information about Docker images that are managed by AWS CodeBuild.
Future<ListProjectsResult>	listProjectsAsync(ListProjectsRequest listProjectsRequest) Gets a list of build project names, with each build project name representing a single build project.
Future<ListProjectsResult>	listProjectsAsync(ListProjectsRequest listProjectsRequest, AsyncHandler<ListProjectsRequest,ListProjectsResult> asyncHandler) Gets a list of build project names, with each build project name representing a single build project.
Future<StartBuildResult>	startBuildAsync(StartBuildRequest startBuildRequest) Starts running a build.
Future<StartBuildResult>	startBuildAsync(StartBuildRequest startBuildRequest, AsyncHandler<StartBuildRequest,StartBuildResult> asyncHandler) Starts running a build.
Future<StopBuildResult>	stopBuildAsync(StopBuildRequest stopBuildRequest) Attempts to stop running a build.
Future<StopBuildResult>	stopBuildAsync(StopBuildRequest stopBuildRequest, AsyncHandler<StopBuildRequest,StopBuildResult> asyncHandler) Attempts to stop running a build.
Future<UpdateProjectResult>	updateProjectAsync(UpdateProjectRequest updateProjectRequest) Changes the settings of a build project.
Future<UpdateProjectResult>	updateProjectAsync(UpdateProjectRequest updateProjectRequest, AsyncHandler<UpdateProjectRequest,UpdateProjectResult> asyncHandler) Changes the settings of a build project.

Methods inherited from interface com.amazonaws.services.codebuild.AWSCodeBuild

batchDeleteBuilds, batchGetBuilds, batchGetProjects, createProject, createWebhook, deleteProject, deleteWebhook, getCachedResponseMetadata, listBuilds, listBuildsForProject, listCuratedEnvironmentImages, listProjects, setEndpoint, setRegion, shutdown, startBuild, stopBuild, updateProject

Method Detail

batchDeleteBuildsAsync

Future<BatchDeleteBuildsResult> batchDeleteBuildsAsync(BatchDeleteBuildsRequest batchDeleteBuildsRequest)

Deletes one or more builds.

Parameters:

batchDeleteBuildsRequest -

Returns:

A Java Future containing the result of the BatchDeleteBuilds operation returned by the service.

See Also:

AWS API Documentation

batchDeleteBuildsAsync

Future<BatchDeleteBuildsResult> batchDeleteBuildsAsync(BatchDeleteBuildsRequest batchDeleteBuildsRequest,
                                                       AsyncHandler<BatchDeleteBuildsRequest,BatchDeleteBuildsResult> asyncHandler)

Deletes one or more builds.

Parameters:

batchDeleteBuildsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchDeleteBuilds operation returned by the service.

See Also:

AWS API Documentation

batchGetBuildsAsync

Future<BatchGetBuildsResult> batchGetBuildsAsync(BatchGetBuildsRequest batchGetBuildsRequest)

Gets information about builds.

Parameters:

batchGetBuildsRequest -

Returns:

A Java Future containing the result of the BatchGetBuilds operation returned by the service.

See Also:

AWS API Documentation

batchGetBuildsAsync

Future<BatchGetBuildsResult> batchGetBuildsAsync(BatchGetBuildsRequest batchGetBuildsRequest,
                                                 AsyncHandler<BatchGetBuildsRequest,BatchGetBuildsResult> asyncHandler)

Gets information about builds.

Parameters:

batchGetBuildsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchGetBuilds operation returned by the service.

See Also:

AWS API Documentation

batchGetProjectsAsync

Future<BatchGetProjectsResult> batchGetProjectsAsync(BatchGetProjectsRequest batchGetProjectsRequest)

Gets information about build projects.

Parameters:

batchGetProjectsRequest -

Returns:

A Java Future containing the result of the BatchGetProjects operation returned by the service.

See Also:

AWS API Documentation

batchGetProjectsAsync

Future<BatchGetProjectsResult> batchGetProjectsAsync(BatchGetProjectsRequest batchGetProjectsRequest,
                                                     AsyncHandler<BatchGetProjectsRequest,BatchGetProjectsResult> asyncHandler)

Gets information about build projects.

Parameters:

batchGetProjectsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchGetProjects operation returned by the service.

See Also:

AWS API Documentation

createProjectAsync

Future<CreateProjectResult> createProjectAsync(CreateProjectRequest createProjectRequest)

Creates a build project.

Parameters:

createProjectRequest -

Returns:

A Java Future containing the result of the CreateProject operation returned by the service.

See Also:

AWS API Documentation

createProjectAsync

Future<CreateProjectResult> createProjectAsync(CreateProjectRequest createProjectRequest,
                                               AsyncHandler<CreateProjectRequest,CreateProjectResult> asyncHandler)

Creates a build project.

Parameters:

createProjectRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateProject operation returned by the service.

See Also:

AWS API Documentation

createWebhookAsync

Future<CreateWebhookResult> createWebhookAsync(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.

See Also:

AWS API Documentation

createWebhookAsync

Future<CreateWebhookResult> createWebhookAsync(CreateWebhookRequest createWebhookRequest,
                                               AsyncHandler<CreateWebhookRequest,CreateWebhookResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateWebhook operation returned by the service.

See Also:

AWS API Documentation

deleteProjectAsync

Future<DeleteProjectResult> deleteProjectAsync(DeleteProjectRequest deleteProjectRequest)

Deletes a build project.

Parameters:

deleteProjectRequest -

Returns:

A Java Future containing the result of the DeleteProject operation returned by the service.

See Also:

AWS API Documentation

deleteProjectAsync

Future<DeleteProjectResult> deleteProjectAsync(DeleteProjectRequest deleteProjectRequest,
                                               AsyncHandler<DeleteProjectRequest,DeleteProjectResult> asyncHandler)

Deletes a build project.

Parameters:

deleteProjectRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteProject operation returned by the service.

See Also:

AWS API Documentation

deleteWebhookAsync

Future<DeleteWebhookResult> deleteWebhookAsync(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.

See Also:

AWS API Documentation

deleteWebhookAsync

Future<DeleteWebhookResult> deleteWebhookAsync(DeleteWebhookRequest deleteWebhookRequest,
                                               AsyncHandler<DeleteWebhookRequest,DeleteWebhookResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteWebhook operation returned by the service.

See Also:

AWS API Documentation

listBuildsAsync

Future<ListBuildsResult> listBuildsAsync(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.

See Also:

AWS API Documentation

listBuildsAsync

Future<ListBuildsResult> listBuildsAsync(ListBuildsRequest listBuildsRequest,
                                         AsyncHandler<ListBuildsRequest,ListBuildsResult> asyncHandler)

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

Parameters:

listBuildsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListBuilds operation returned by the service.

See Also:

AWS API Documentation

listBuildsForProjectAsync

Future<ListBuildsForProjectResult> listBuildsForProjectAsync(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.

See Also:

AWS API Documentation

listBuildsForProjectAsync

Future<ListBuildsForProjectResult> listBuildsForProjectAsync(ListBuildsForProjectRequest listBuildsForProjectRequest,
                                                             AsyncHandler<ListBuildsForProjectRequest,ListBuildsForProjectResult> asyncHandler)

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

Parameters:

listBuildsForProjectRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListBuildsForProject operation returned by the service.

See Also:

AWS API Documentation

listCuratedEnvironmentImagesAsync

Future<ListCuratedEnvironmentImagesResult> listCuratedEnvironmentImagesAsync(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

listCuratedEnvironmentImagesAsync

Future<ListCuratedEnvironmentImagesResult> listCuratedEnvironmentImagesAsync(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest,
                                                                             AsyncHandler<ListCuratedEnvironmentImagesRequest,ListCuratedEnvironmentImagesResult> asyncHandler)

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

Parameters:

listCuratedEnvironmentImagesRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListCuratedEnvironmentImages operation returned by the service.

See Also:

AWS API Documentation

listProjectsAsync

Future<ListProjectsResult> listProjectsAsync(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.

See Also:

AWS API Documentation

listProjectsAsync

Future<ListProjectsResult> listProjectsAsync(ListProjectsRequest listProjectsRequest,
                                             AsyncHandler<ListProjectsRequest,ListProjectsResult> asyncHandler)

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

Parameters:

listProjectsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListProjects operation returned by the service.

See Also:

AWS API Documentation

startBuildAsync

Future<StartBuildResult> startBuildAsync(StartBuildRequest startBuildRequest)

Starts running a build.

Parameters:

startBuildRequest -

Returns:

A Java Future containing the result of the StartBuild operation returned by the service.

See Also:

AWS API Documentation

startBuildAsync

Future<StartBuildResult> startBuildAsync(StartBuildRequest startBuildRequest,
                                         AsyncHandler<StartBuildRequest,StartBuildResult> asyncHandler)

Starts running a build.

Parameters:

startBuildRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the StartBuild operation returned by the service.

See Also:

AWS API Documentation

stopBuildAsync

Future<StopBuildResult> stopBuildAsync(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.

See Also:

AWS API Documentation

stopBuildAsync

Future<StopBuildResult> stopBuildAsync(StopBuildRequest stopBuildRequest,
                                       AsyncHandler<StopBuildRequest,StopBuildResult> asyncHandler)

Attempts to stop running a build.

Parameters:

stopBuildRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the StopBuild operation returned by the service.

See Also:

AWS API Documentation

updateProjectAsync

Future<UpdateProjectResult> updateProjectAsync(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.

See Also:

AWS API Documentation

updateProjectAsync

Future<UpdateProjectResult> updateProjectAsync(UpdateProjectRequest updateProjectRequest,
                                               AsyncHandler<UpdateProjectRequest,UpdateProjectResult> asyncHandler)

Changes the settings of a build project.

Parameters:

updateProjectRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateProject operation returned by the service.

See Also:

AWS API Documentation