@Generated(value="software.amazon.awssdk:codegen") public interface CodeBuildAsyncClient extends SdkClient
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
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.
|
serviceName
close
static final String SERVICE_NAME
static CodeBuildAsyncClient create()
CodeBuildAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CodeBuildAsyncClientBuilder builder()
CodeBuildAsyncClient
.default CompletableFuture<BatchDeleteBuildsResponse> batchDeleteBuilds(BatchDeleteBuildsRequest batchDeleteBuildsRequest)
Deletes one or more builds.
batchDeleteBuildsRequest
- 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()
batchDeleteBuildsRequest
- A Consumer
that will call methods on BatchDeleteBuildsInput.Builder
to create a request.default CompletableFuture<BatchGetBuildsResponse> batchGetBuilds(BatchGetBuildsRequest batchGetBuildsRequest)
Gets information about builds.
batchGetBuildsRequest
- 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()
batchGetBuildsRequest
- A Consumer
that will call methods on BatchGetBuildsInput.Builder
to create a request.default CompletableFuture<BatchGetProjectsResponse> batchGetProjects(BatchGetProjectsRequest batchGetProjectsRequest)
Gets information about build projects.
batchGetProjectsRequest
- 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()
batchGetProjectsRequest
- A Consumer
that will call methods on BatchGetProjectsInput.Builder
to create a request.default CompletableFuture<CreateProjectResponse> createProject(CreateProjectRequest createProjectRequest)
Creates a build project.
createProjectRequest
- 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()
createProjectRequest
- A Consumer
that will call methods on CreateProjectInput.Builder
to create a request.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.
createWebhookRequest
- 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()
createWebhookRequest
- A Consumer
that will call methods on CreateWebhookInput.Builder
to create a request.default CompletableFuture<DeleteProjectResponse> deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes a build project.
deleteProjectRequest
- 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()
deleteProjectRequest
- A Consumer
that will call methods on DeleteProjectInput.Builder
to create a request.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.
deleteWebhookRequest
- 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()
deleteWebhookRequest
- A Consumer
that will call methods on DeleteWebhookInput.Builder
to create a request.default CompletableFuture<ListBuildsResponse> listBuilds(ListBuildsRequest listBuildsRequest)
Gets a list of build IDs, with each build ID representing a single build.
listBuildsRequest
- 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()
listBuildsRequest
- A Consumer
that will call methods on ListBuildsInput.Builder
to create a request.default CompletableFuture<ListBuildsResponse> listBuilds()
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.
listBuildsForProjectRequest
- 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()
listBuildsForProjectRequest
- A Consumer
that will call methods on ListBuildsForProjectInput.Builder
to create a
request.default CompletableFuture<ListCuratedEnvironmentImagesResponse> listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest)
Gets information about Docker images that are managed by AWS CodeBuild.
listCuratedEnvironmentImagesRequest
- 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()
listCuratedEnvironmentImagesRequest
- A Consumer
that will call methods on ListCuratedEnvironmentImagesInput.Builder
to create a
request.default CompletableFuture<ListCuratedEnvironmentImagesResponse> listCuratedEnvironmentImages()
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.
listProjectsRequest
- 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()
listProjectsRequest
- A Consumer
that will call methods on ListProjectsInput.Builder
to create a request.default CompletableFuture<ListProjectsResponse> listProjects()
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.
startBuildRequest
- 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()
startBuildRequest
- A Consumer
that will call methods on StartBuildInput.Builder
to create a request.default CompletableFuture<StopBuildResponse> stopBuild(StopBuildRequest stopBuildRequest)
Attempts to stop running a build.
stopBuildRequest
- 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()
stopBuildRequest
- A Consumer
that will call methods on StopBuildInput.Builder
to create a request.default CompletableFuture<UpdateProjectResponse> updateProject(UpdateProjectRequest updateProjectRequest)
Changes the settings of a build project.
updateProjectRequest
- 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()
updateProjectRequest
- A Consumer
that will call methods on UpdateProjectInput.Builder
to create a request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.