@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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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 AWSCodeBuildendpoint - 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)
AWSCodeBuildAWSCodeBuild.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 AWSCodeBuildregion - 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)
AWSCodeBuildDeletes one or more builds.
batchDeleteBuilds in interface AWSCodeBuildpublic BatchGetBuildBatchesResult batchGetBuildBatches(BatchGetBuildBatchesRequest request)
AWSCodeBuildRetrieves information about one or more batch builds.
batchGetBuildBatches in interface AWSCodeBuildpublic BatchGetBuildsResult batchGetBuilds(BatchGetBuildsRequest request)
AWSCodeBuildGets information about one or more builds.
batchGetBuilds in interface AWSCodeBuildpublic BatchGetProjectsResult batchGetProjects(BatchGetProjectsRequest request)
AWSCodeBuildGets information about one or more build projects.
batchGetProjects in interface AWSCodeBuildpublic BatchGetReportGroupsResult batchGetReportGroups(BatchGetReportGroupsRequest request)
AWSCodeBuildReturns an array of report groups.
batchGetReportGroups in interface AWSCodeBuildpublic BatchGetReportsResult batchGetReports(BatchGetReportsRequest request)
AWSCodeBuildReturns an array of reports.
batchGetReports in interface AWSCodeBuildpublic CreateProjectResult createProject(CreateProjectRequest request)
AWSCodeBuildCreates a build project.
createProject in interface AWSCodeBuildpublic CreateReportGroupResult createReportGroup(CreateReportGroupRequest request)
AWSCodeBuildCreates a report group. A report group contains a collection of reports.
createReportGroup in interface AWSCodeBuildpublic CreateWebhookResult createWebhook(CreateWebhookRequest request)
AWSCodeBuildFor 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 AWSCodeBuildpublic DeleteBuildBatchResult deleteBuildBatch(DeleteBuildBatchRequest request)
AWSCodeBuildDeletes a batch build.
deleteBuildBatch in interface AWSCodeBuildpublic DeleteProjectResult deleteProject(DeleteProjectRequest request)
AWSCodeBuildDeletes a build project. When you delete a project, its builds are not deleted.
deleteProject in interface AWSCodeBuildpublic DeleteReportResult deleteReport(DeleteReportRequest request)
AWSCodeBuildDeletes a report.
deleteReport in interface AWSCodeBuildpublic DeleteReportGroupResult deleteReportGroup(DeleteReportGroupRequest request)
AWSCodeBuildDeletes a report group. Before you delete a report group, you must delete its reports.
deleteReportGroup in interface AWSCodeBuildpublic DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
AWSCodeBuildDeletes a resource policy that is identified by its resource ARN.
deleteResourcePolicy in interface AWSCodeBuildpublic DeleteSourceCredentialsResult deleteSourceCredentials(DeleteSourceCredentialsRequest request)
AWSCodeBuildDeletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
deleteSourceCredentials in interface AWSCodeBuildpublic DeleteWebhookResult deleteWebhook(DeleteWebhookRequest request)
AWSCodeBuildFor 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 AWSCodeBuildpublic DescribeCodeCoveragesResult describeCodeCoverages(DescribeCodeCoveragesRequest request)
AWSCodeBuildRetrieves one or more code coverage reports.
describeCodeCoverages in interface AWSCodeBuildpublic DescribeTestCasesResult describeTestCases(DescribeTestCasesRequest request)
AWSCodeBuildReturns a list of details about test cases for a report.
describeTestCases in interface AWSCodeBuildpublic GetReportGroupTrendResult getReportGroupTrend(GetReportGroupTrendRequest request)
AWSCodeBuildAnalyzes and accumulates test report values for the specified test reports.
getReportGroupTrend in interface AWSCodeBuildpublic GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest request)
AWSCodeBuildGets a resource policy that is identified by its resource ARN.
getResourcePolicy in interface AWSCodeBuildpublic ImportSourceCredentialsResult importSourceCredentials(ImportSourceCredentialsRequest request)
AWSCodeBuildImports 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 AWSCodeBuildpublic InvalidateProjectCacheResult invalidateProjectCache(InvalidateProjectCacheRequest request)
AWSCodeBuildResets the cache for a project.
invalidateProjectCache in interface AWSCodeBuildpublic ListBuildBatchesResult listBuildBatches(ListBuildBatchesRequest request)
AWSCodeBuildRetrieves the identifiers of your build batches in the current region.
listBuildBatches in interface AWSCodeBuildpublic ListBuildBatchesForProjectResult listBuildBatchesForProject(ListBuildBatchesForProjectRequest request)
AWSCodeBuildRetrieves the identifiers of the build batches for a specific project.
listBuildBatchesForProject in interface AWSCodeBuildpublic ListBuildsResult listBuilds(ListBuildsRequest request)
AWSCodeBuildGets a list of build IDs, with each build ID representing a single build.
listBuilds in interface AWSCodeBuildpublic ListBuildsForProjectResult listBuildsForProject(ListBuildsForProjectRequest request)
AWSCodeBuildGets a list of build identifiers for the specified build project, with each build identifier representing a single build.
listBuildsForProject in interface AWSCodeBuildpublic ListCuratedEnvironmentImagesResult listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest request)
AWSCodeBuildGets information about Docker images that are managed by CodeBuild.
listCuratedEnvironmentImages in interface AWSCodeBuildpublic ListProjectsResult listProjects(ListProjectsRequest request)
AWSCodeBuildGets a list of build project names, with each build project name representing a single build project.
listProjects in interface AWSCodeBuildpublic ListReportGroupsResult listReportGroups(ListReportGroupsRequest request)
AWSCodeBuildGets a list ARNs for the report groups in the current Amazon Web Services account.
listReportGroups in interface AWSCodeBuildpublic ListReportsResult listReports(ListReportsRequest request)
AWSCodeBuildReturns a list of ARNs for the reports in the current Amazon Web Services account.
listReports in interface AWSCodeBuildpublic ListReportsForReportGroupResult listReportsForReportGroup(ListReportsForReportGroupRequest request)
AWSCodeBuild
Returns a list of ARNs for the reports that belong to a ReportGroup.
listReportsForReportGroup in interface AWSCodeBuildpublic ListSharedProjectsResult listSharedProjects(ListSharedProjectsRequest request)
AWSCodeBuildGets a list of projects that are shared with other Amazon Web Services accounts or users.
listSharedProjects in interface AWSCodeBuildpublic ListSharedReportGroupsResult listSharedReportGroups(ListSharedReportGroupsRequest request)
AWSCodeBuildGets a list of report groups that are shared with other Amazon Web Services accounts or users.
listSharedReportGroups in interface AWSCodeBuildpublic ListSourceCredentialsResult listSourceCredentials(ListSourceCredentialsRequest request)
AWSCodeBuild
Returns a list of SourceCredentialsInfo objects.
listSourceCredentials in interface AWSCodeBuildpublic PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
AWSCodeBuild
Stores a resource policy for the ARN of a Project or ReportGroup object.
putResourcePolicy in interface AWSCodeBuildpublic RetryBuildResult retryBuild(RetryBuildRequest request)
AWSCodeBuildRestarts a build.
retryBuild in interface AWSCodeBuildpublic RetryBuildBatchResult retryBuildBatch(RetryBuildBatchRequest request)
AWSCodeBuildRestarts a failed batch build. Only batch builds that have failed can be retried.
retryBuildBatch in interface AWSCodeBuildpublic StartBuildResult startBuild(StartBuildRequest request)
AWSCodeBuildStarts running a build.
startBuild in interface AWSCodeBuildpublic StartBuildBatchResult startBuildBatch(StartBuildBatchRequest request)
AWSCodeBuildStarts a batch build for a project.
startBuildBatch in interface AWSCodeBuildpublic StopBuildResult stopBuild(StopBuildRequest request)
AWSCodeBuildAttempts to stop running a build.
stopBuild in interface AWSCodeBuildpublic StopBuildBatchResult stopBuildBatch(StopBuildBatchRequest request)
AWSCodeBuildStops a running batch build.
stopBuildBatch in interface AWSCodeBuildpublic UpdateProjectResult updateProject(UpdateProjectRequest request)
AWSCodeBuildChanges the settings of a build project.
updateProject in interface AWSCodeBuildpublic UpdateProjectVisibilityResult updateProjectVisibility(UpdateProjectVisibilityRequest request)
AWSCodeBuildChanges 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, especially Amazon Web Services access key IDs and secret access keys, 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 AWSCodeBuildpublic UpdateReportGroupResult updateReportGroup(UpdateReportGroupRequest request)
AWSCodeBuildUpdates a report group.
updateReportGroup in interface AWSCodeBuildpublic UpdateWebhookResult updateWebhook(UpdateWebhookRequest request)
AWSCodeBuildUpdates the webhook associated with an CodeBuild build project.
If you use Bitbucket for your repository, rotateSecret is ignored.
updateWebhook in interface AWSCodeBuildpublic void shutdown()
AWSCodeBuildshutdown in interface AWSCodeBuildpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSCodeBuildResponse 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 AWSCodeBuildrequest - The originally executed request.