@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSCodeBuild extends Object implements AWSCodeBuild
AWSCodeBuild
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchDeleteBuildsResult |
batchDeleteBuilds(BatchDeleteBuildsRequest request)
Deletes one or more builds.
|
BatchGetBuildBatchesResult |
batchGetBuildBatches(BatchGetBuildBatchesRequest request)
Retrieves information about one or more batch builds.
|
BatchGetBuildsResult |
batchGetBuilds(BatchGetBuildsRequest request)
Gets information about one or more builds.
|
BatchGetFleetsResult |
batchGetFleets(BatchGetFleetsRequest request)
Gets information about one or more compute fleets.
|
BatchGetProjectsResult |
batchGetProjects(BatchGetProjectsRequest request)
Gets information about one or more build projects.
|
BatchGetReportGroupsResult |
batchGetReportGroups(BatchGetReportGroupsRequest request)
Returns an array of report groups.
|
BatchGetReportsResult |
batchGetReports(BatchGetReportsRequest request)
Returns an array of reports.
|
CreateFleetResult |
createFleet(CreateFleetRequest request)
Creates a compute fleet.
|
CreateProjectResult |
createProject(CreateProjectRequest request)
Creates a build project.
|
CreateReportGroupResult |
createReportGroup(CreateReportGroupRequest request)
Creates a report group.
|
CreateWebhookResult |
createWebhook(CreateWebhookRequest request)
For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository,
enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.
|
DeleteBuildBatchResult |
deleteBuildBatch(DeleteBuildBatchRequest request)
Deletes a batch build.
|
DeleteFleetResult |
deleteFleet(DeleteFleetRequest request)
Deletes a compute fleet.
|
DeleteProjectResult |
deleteProject(DeleteProjectRequest request)
Deletes a build project.
|
DeleteReportResult |
deleteReport(DeleteReportRequest request)
Deletes a report.
|
DeleteReportGroupResult |
deleteReportGroup(DeleteReportGroupRequest request)
Deletes a report group.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes a resource policy that is identified by its resource ARN.
|
DeleteSourceCredentialsResult |
deleteSourceCredentials(DeleteSourceCredentialsRequest request)
Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
|
DeleteWebhookResult |
deleteWebhook(DeleteWebhookRequest request)
For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository,
stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
|
DescribeCodeCoveragesResult |
describeCodeCoverages(DescribeCodeCoveragesRequest request)
Retrieves one or more code coverage reports.
|
DescribeTestCasesResult |
describeTestCases(DescribeTestCasesRequest request)
Returns a list of details about test cases for a report.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetReportGroupTrendResult |
getReportGroupTrend(GetReportGroupTrendRequest request)
Analyzes and accumulates test report values for the specified test reports.
|
GetResourcePolicyResult |
getResourcePolicy(GetResourcePolicyRequest request)
Gets a resource policy that is identified by its resource ARN.
|
ImportSourceCredentialsResult |
importSourceCredentials(ImportSourceCredentialsRequest request)
Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub,
GitHub Enterprise, or Bitbucket repository.
|
InvalidateProjectCacheResult |
invalidateProjectCache(InvalidateProjectCacheRequest request)
Resets the cache for a project.
|
ListBuildBatchesResult |
listBuildBatches(ListBuildBatchesRequest request)
Retrieves the identifiers of your build batches in the current region.
|
ListBuildBatchesForProjectResult |
listBuildBatchesForProject(ListBuildBatchesForProjectRequest request)
Retrieves the identifiers of the build batches for a specific project.
|
ListBuildsResult |
listBuilds(ListBuildsRequest request)
Gets a list of build IDs, with each build ID representing a single build.
|
ListBuildsForProjectResult |
listBuildsForProject(ListBuildsForProjectRequest request)
Gets a list of build identifiers for the specified build project, with each build identifier representing a
single build.
|
ListCuratedEnvironmentImagesResult |
listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest request)
Gets information about Docker images that are managed by CodeBuild.
|
ListFleetsResult |
listFleets(ListFleetsRequest request)
Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.
|
ListProjectsResult |
listProjects(ListProjectsRequest request)
Gets a list of build project names, with each build project name representing a single build project.
|
ListReportGroupsResult |
listReportGroups(ListReportGroupsRequest request)
Gets a list ARNs for the report groups in the current Amazon Web Services account.
|
ListReportsResult |
listReports(ListReportsRequest request)
Returns a list of ARNs for the reports in the current Amazon Web Services account.
|
ListReportsForReportGroupResult |
listReportsForReportGroup(ListReportsForReportGroupRequest request)
Returns a list of ARNs for the reports that belong to a
ReportGroup . |
ListSharedProjectsResult |
listSharedProjects(ListSharedProjectsRequest request)
Gets a list of projects that are shared with other Amazon Web Services accounts or users.
|
ListSharedReportGroupsResult |
listSharedReportGroups(ListSharedReportGroupsRequest request)
Gets a list of report groups that are shared with other Amazon Web Services accounts or users.
|
ListSourceCredentialsResult |
listSourceCredentials(ListSourceCredentialsRequest request)
Returns a list of
SourceCredentialsInfo objects. |
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest request)
Stores a resource policy for the ARN of a
Project or ReportGroup object. |
RetryBuildResult |
retryBuild(RetryBuildRequest request)
Restarts a build.
|
RetryBuildBatchResult |
retryBuildBatch(RetryBuildBatchRequest request)
Restarts a failed batch build.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("codebuild.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSCodeBuild.setEndpoint(String) , sets the regional endpoint for this client's service
calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartBuildResult |
startBuild(StartBuildRequest request)
Starts running a build with the settings defined in the project.
|
StartBuildBatchResult |
startBuildBatch(StartBuildBatchRequest request)
Starts a batch build for a project.
|
StopBuildResult |
stopBuild(StopBuildRequest request)
Attempts to stop running a build.
|
StopBuildBatchResult |
stopBuildBatch(StopBuildBatchRequest request)
Stops a running batch build.
|
UpdateFleetResult |
updateFleet(UpdateFleetRequest request)
Updates a compute fleet.
|
UpdateProjectResult |
updateProject(UpdateProjectRequest request)
Changes the settings of a build project.
|
UpdateProjectVisibilityResult |
updateProjectVisibility(UpdateProjectVisibilityRequest request)
Changes the public visibility for a project.
|
UpdateReportGroupResult |
updateReportGroup(UpdateReportGroupRequest request)
Updates a report group.
|
UpdateWebhookResult |
updateWebhook(UpdateWebhookRequest request)
Updates the webhook associated with an CodeBuild build project.
|
public void setEndpoint(String endpoint)
AWSCodeBuild
Callers can pass in just the endpoint (ex: "codebuild.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "codebuild.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol
from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSCodeBuild
endpoint
- The endpoint (ex: "codebuild.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"codebuild.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AWSCodeBuild
AWSCodeBuild.setEndpoint(String)
, sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSCodeBuild
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public BatchDeleteBuildsResult batchDeleteBuilds(BatchDeleteBuildsRequest request)
AWSCodeBuild
Deletes one or more builds.
batchDeleteBuilds
in interface AWSCodeBuild
public BatchGetBuildBatchesResult batchGetBuildBatches(BatchGetBuildBatchesRequest request)
AWSCodeBuild
Retrieves information about one or more batch builds.
batchGetBuildBatches
in interface AWSCodeBuild
public BatchGetBuildsResult batchGetBuilds(BatchGetBuildsRequest request)
AWSCodeBuild
Gets information about one or more builds.
batchGetBuilds
in interface AWSCodeBuild
public BatchGetFleetsResult batchGetFleets(BatchGetFleetsRequest request)
AWSCodeBuild
Gets information about one or more compute fleets.
batchGetFleets
in interface AWSCodeBuild
public BatchGetProjectsResult batchGetProjects(BatchGetProjectsRequest request)
AWSCodeBuild
Gets information about one or more build projects.
batchGetProjects
in interface AWSCodeBuild
public BatchGetReportGroupsResult batchGetReportGroups(BatchGetReportGroupsRequest request)
AWSCodeBuild
Returns an array of report groups.
batchGetReportGroups
in interface AWSCodeBuild
public BatchGetReportsResult batchGetReports(BatchGetReportsRequest request)
AWSCodeBuild
Returns an array of reports.
batchGetReports
in interface AWSCodeBuild
public CreateFleetResult createFleet(CreateFleetRequest request)
AWSCodeBuild
Creates a compute fleet.
createFleet
in interface AWSCodeBuild
public CreateProjectResult createProject(CreateProjectRequest request)
AWSCodeBuild
Creates a build project.
createProject
in interface AWSCodeBuild
public CreateReportGroupResult createReportGroup(CreateReportGroupRequest request)
AWSCodeBuild
Creates a report group. A report group contains a collection of reports.
createReportGroup
in interface AWSCodeBuild
public CreateWebhookResult createWebhook(CreateWebhookRequest request)
AWSCodeBuild
For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.
If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.
createWebhook
in interface AWSCodeBuild
public DeleteBuildBatchResult deleteBuildBatch(DeleteBuildBatchRequest request)
AWSCodeBuild
Deletes a batch build.
deleteBuildBatch
in interface AWSCodeBuild
public DeleteFleetResult deleteFleet(DeleteFleetRequest request)
AWSCodeBuild
Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted.
deleteFleet
in interface AWSCodeBuild
public DeleteProjectResult deleteProject(DeleteProjectRequest request)
AWSCodeBuild
Deletes a build project. When you delete a project, its builds are not deleted.
deleteProject
in interface AWSCodeBuild
public DeleteReportResult deleteReport(DeleteReportRequest request)
AWSCodeBuild
Deletes a report.
deleteReport
in interface AWSCodeBuild
public DeleteReportGroupResult deleteReportGroup(DeleteReportGroupRequest request)
AWSCodeBuild
Deletes a report group. Before you delete a report group, you must delete its reports.
deleteReportGroup
in interface AWSCodeBuild
public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
AWSCodeBuild
Deletes a resource policy that is identified by its resource ARN.
deleteResourcePolicy
in interface AWSCodeBuild
public DeleteSourceCredentialsResult deleteSourceCredentials(DeleteSourceCredentialsRequest request)
AWSCodeBuild
Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
deleteSourceCredentials
in interface AWSCodeBuild
public DeleteWebhookResult deleteWebhook(DeleteWebhookRequest request)
AWSCodeBuild
For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
deleteWebhook
in interface AWSCodeBuild
public DescribeCodeCoveragesResult describeCodeCoverages(DescribeCodeCoveragesRequest request)
AWSCodeBuild
Retrieves one or more code coverage reports.
describeCodeCoverages
in interface AWSCodeBuild
public DescribeTestCasesResult describeTestCases(DescribeTestCasesRequest request)
AWSCodeBuild
Returns a list of details about test cases for a report.
describeTestCases
in interface AWSCodeBuild
public GetReportGroupTrendResult getReportGroupTrend(GetReportGroupTrendRequest request)
AWSCodeBuild
Analyzes and accumulates test report values for the specified test reports.
getReportGroupTrend
in interface AWSCodeBuild
public GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest request)
AWSCodeBuild
Gets a resource policy that is identified by its resource ARN.
getResourcePolicy
in interface AWSCodeBuild
public ImportSourceCredentialsResult importSourceCredentials(ImportSourceCredentialsRequest request)
AWSCodeBuild
Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
importSourceCredentials
in interface AWSCodeBuild
public InvalidateProjectCacheResult invalidateProjectCache(InvalidateProjectCacheRequest request)
AWSCodeBuild
Resets the cache for a project.
invalidateProjectCache
in interface AWSCodeBuild
public ListBuildBatchesResult listBuildBatches(ListBuildBatchesRequest request)
AWSCodeBuild
Retrieves the identifiers of your build batches in the current region.
listBuildBatches
in interface AWSCodeBuild
public ListBuildBatchesForProjectResult listBuildBatchesForProject(ListBuildBatchesForProjectRequest request)
AWSCodeBuild
Retrieves the identifiers of the build batches for a specific project.
listBuildBatchesForProject
in interface AWSCodeBuild
public ListBuildsResult listBuilds(ListBuildsRequest request)
AWSCodeBuild
Gets a list of build IDs, with each build ID representing a single build.
listBuilds
in interface AWSCodeBuild
public ListBuildsForProjectResult listBuildsForProject(ListBuildsForProjectRequest request)
AWSCodeBuild
Gets a list of build identifiers for the specified build project, with each build identifier representing a single build.
listBuildsForProject
in interface AWSCodeBuild
public ListCuratedEnvironmentImagesResult listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest request)
AWSCodeBuild
Gets information about Docker images that are managed by CodeBuild.
listCuratedEnvironmentImages
in interface AWSCodeBuild
public ListFleetsResult listFleets(ListFleetsRequest request)
AWSCodeBuild
Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.
listFleets
in interface AWSCodeBuild
public ListProjectsResult listProjects(ListProjectsRequest request)
AWSCodeBuild
Gets a list of build project names, with each build project name representing a single build project.
listProjects
in interface AWSCodeBuild
public ListReportGroupsResult listReportGroups(ListReportGroupsRequest request)
AWSCodeBuild
Gets a list ARNs for the report groups in the current Amazon Web Services account.
listReportGroups
in interface AWSCodeBuild
public ListReportsResult listReports(ListReportsRequest request)
AWSCodeBuild
Returns a list of ARNs for the reports in the current Amazon Web Services account.
listReports
in interface AWSCodeBuild
public ListReportsForReportGroupResult listReportsForReportGroup(ListReportsForReportGroupRequest request)
AWSCodeBuild
Returns a list of ARNs for the reports that belong to a ReportGroup
.
listReportsForReportGroup
in interface AWSCodeBuild
public ListSharedProjectsResult listSharedProjects(ListSharedProjectsRequest request)
AWSCodeBuild
Gets a list of projects that are shared with other Amazon Web Services accounts or users.
listSharedProjects
in interface AWSCodeBuild
public ListSharedReportGroupsResult listSharedReportGroups(ListSharedReportGroupsRequest request)
AWSCodeBuild
Gets a list of report groups that are shared with other Amazon Web Services accounts or users.
listSharedReportGroups
in interface AWSCodeBuild
public ListSourceCredentialsResult listSourceCredentials(ListSourceCredentialsRequest request)
AWSCodeBuild
Returns a list of SourceCredentialsInfo
objects.
listSourceCredentials
in interface AWSCodeBuild
public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
AWSCodeBuild
Stores a resource policy for the ARN of a Project
or ReportGroup
object.
putResourcePolicy
in interface AWSCodeBuild
public RetryBuildResult retryBuild(RetryBuildRequest request)
AWSCodeBuild
Restarts a build.
retryBuild
in interface AWSCodeBuild
public RetryBuildBatchResult retryBuildBatch(RetryBuildBatchRequest request)
AWSCodeBuild
Restarts a failed batch build. Only batch builds that have failed can be retried.
retryBuildBatch
in interface AWSCodeBuild
public StartBuildResult startBuild(StartBuildRequest request)
AWSCodeBuild
Starts running a build with the settings defined in the project. These setting include: how to run a build, where to get the source code, which build environment to use, which build commands to run, and where to store the build output.
You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that specific start build request. The settings in the project are unaltered.
startBuild
in interface AWSCodeBuild
public StartBuildBatchResult startBuildBatch(StartBuildBatchRequest request)
AWSCodeBuild
Starts a batch build for a project.
startBuildBatch
in interface AWSCodeBuild
public StopBuildResult stopBuild(StopBuildRequest request)
AWSCodeBuild
Attempts to stop running a build.
stopBuild
in interface AWSCodeBuild
public StopBuildBatchResult stopBuildBatch(StopBuildBatchRequest request)
AWSCodeBuild
Stops a running batch build.
stopBuildBatch
in interface AWSCodeBuild
public UpdateFleetResult updateFleet(UpdateFleetRequest request)
AWSCodeBuild
Updates a compute fleet.
updateFleet
in interface AWSCodeBuild
public UpdateProjectResult updateProject(UpdateProjectRequest request)
AWSCodeBuild
Changes the settings of a build project.
updateProject
in interface AWSCodeBuild
public UpdateProjectVisibilityResult updateProjectVisibility(UpdateProjectVisibilityRequest request)
AWSCodeBuild
Changes the public visibility for a project. The project's build results, logs, and artifacts are available to the general public. For more information, see Public build projects in the CodeBuild User Guide.
The following should be kept in mind when making your projects public:
All of a project's build results, logs, and artifacts, including builds that were run when the project was private, are available to the general public.
All build logs and artifacts are available to the public. Environment variables, source code, and other sensitive information may have been output to the build logs and artifacts. You must be careful about what information is output to the build logs. Some best practice are:
Do not store sensitive values in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive values.
Follow Best practices for using webhooks in the CodeBuild User Guide to limit which entities can trigger a build, and do not store the buildspec in the project itself, to ensure that your webhooks are as secure as possible.
A malicious user can use public builds to distribute malicious artifacts. We recommend that you review all pull requests to verify that the pull request is a legitimate change. We also recommend that you validate any artifacts with their checksums to make sure that the correct artifacts are being downloaded.
updateProjectVisibility
in interface AWSCodeBuild
public UpdateReportGroupResult updateReportGroup(UpdateReportGroupRequest request)
AWSCodeBuild
Updates a report group.
updateReportGroup
in interface AWSCodeBuild
public UpdateWebhookResult updateWebhook(UpdateWebhookRequest request)
AWSCodeBuild
Updates the webhook associated with an CodeBuild build project.
If you use Bitbucket for your repository, rotateSecret
is ignored.
updateWebhook
in interface AWSCodeBuild
public void shutdown()
AWSCodeBuild
shutdown
in interface AWSCodeBuild
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSCodeBuild
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSCodeBuild
request
- The originally executed request.