CodeBuildClient Class
(QtAws::CodeBuild::CodeBuildClient)The CodeBuildClient class provides access to the AWS CodeBuild service. More...
| Header: | #include <CodeBuildClient> |
| Inherits: | QtAws::Core::AwsAbstractClient |
Public Functions
| CodeBuildClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0) | |
| CodeBuildClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0) |
- 12 public functions inherited from QtAws::Core::AwsAbstractClient
Public Slots
| BatchDeleteBuildsResponse * | batchDeleteBuilds(const BatchDeleteBuildsRequest &request) |
| BatchGetBuildsResponse * | batchGetBuilds(const BatchGetBuildsRequest &request) |
| BatchGetProjectsResponse * | batchGetProjects(const BatchGetProjectsRequest &request) |
| CreateProjectResponse * | createProject(const CreateProjectRequest &request) |
| CreateWebhookResponse * | createWebhook(const CreateWebhookRequest &request) |
| DeleteProjectResponse * | deleteProject(const DeleteProjectRequest &request) |
| DeleteWebhookResponse * | deleteWebhook(const DeleteWebhookRequest &request) |
| InvalidateProjectCacheResponse * | invalidateProjectCache(const InvalidateProjectCacheRequest &request) |
| ListBuildsResponse * | listBuilds(const ListBuildsRequest &request) |
| ListBuildsForProjectResponse * | listBuildsForProject(const ListBuildsForProjectRequest &request) |
| ListCuratedEnvironmentImagesResponse * | listCuratedEnvironmentImages(const ListCuratedEnvironmentImagesRequest &request) |
| ListProjectsResponse * | listProjects(const ListProjectsRequest &request) |
| StartBuildResponse * | startBuild(const StartBuildRequest &request) |
| StopBuildResponse * | stopBuild(const StopBuildRequest &request) |
| UpdateProjectResponse * | updateProject(const UpdateProjectRequest &request) |
| UpdateWebhookResponse * | updateWebhook(const UpdateWebhookRequest &request) |
Additional Inherited Members
- 2 protected functions inherited from QtAws::Core::AwsAbstractClient
Detailed Description
The CodeBuildClient class provides access to the AWS CodeBuild service.
<fullname>AWS CodeBuild</fullname>
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 <i>AWS CodeBuild User
Guide</i>>
AWS CodeBuild supports these
operations> <ul> <li>
<code>BatchDeleteBuilds</code>: Deletes one or more
builds> </li> <li>
<code>BatchGetProjects</code>: Gets information about one or more build projects. A <i>build project</i> 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 <i>build environment</i> 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> </li> <li>
<code>CreateProject</code>: Creates a build
project> </li> <li>
<code>CreateWebhook</code>: 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> </li> <li>
<code>UpdateWebhook</code>: Changes the settings of an existing
webhook> </li> <li>
<code>DeleteProject</code>: Deletes a build
project> </li> <li>
<code>DeleteWebhook</code>: 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> </li> <li>
<code>ListProjects</code>: Gets a list of build project names, with each build project name representing a single build
project> </li> <li>
<code>UpdateProject</code>: Changes the settings of an existing build
project> </li> <li>
<code>BatchGetBuilds</code>: Gets information about one or more
builds> </li> <li>
<code>ListBuilds</code>: Gets a list of build IDs, with each build ID representing a single
build> </li> <li>
<code>ListBuildsForProject</code>: Gets a list of build IDs for the specified build project, with each build ID representing a single
build> </li> <li>
<code>StartBuild</code>: Starts running a
build> </li> <li>
<code>StopBuild</code>: Attempts to stop running a
build> </li> <li>
<code>ListCuratedEnvironmentImages</code>: Gets information about Docker images that are managed by AWS
Member Function Documentation
CodeBuildClient::CodeBuildClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
Constructs a CodeBuildClient object.
The new client object will region, credentials, and manager for network operations.
The new object will be owned by parent, if set.
CodeBuildClient::CodeBuildClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
This function overloads CodeBuildClient().
This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).
See also QtAws::Core::AwsEndpoint::getEndpoint.
[slot] BatchDeleteBuildsResponse *CodeBuildClient::batchDeleteBuilds(const BatchDeleteBuildsRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an BatchDeleteBuildsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes one or more
[slot] BatchGetBuildsResponse *CodeBuildClient::batchGetBuilds(const BatchGetBuildsRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an BatchGetBuildsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets information about
[slot] BatchGetProjectsResponse *CodeBuildClient::batchGetProjects(const BatchGetProjectsRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an BatchGetProjectsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets information about build
[slot] CreateProjectResponse *CodeBuildClient::createProject(const CreateProjectRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an CreateProjectResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Creates a build
[slot] CreateWebhookResponse *CodeBuildClient::createWebhook(const CreateWebhookRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an CreateWebhookResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
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> <b>
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 5 in <a href="http://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console">Change a Build Project's
[slot] DeleteProjectResponse *CodeBuildClient::deleteProject(const DeleteProjectRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an DeleteProjectResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes a build
[slot] DeleteWebhookResponse *CodeBuildClient::deleteWebhook(const DeleteWebhookRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an DeleteWebhookResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
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
[slot] InvalidateProjectCacheResponse *CodeBuildClient::invalidateProjectCache(const InvalidateProjectCacheRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an InvalidateProjectCacheResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Resets the cache for a
[slot] ListBuildsResponse *CodeBuildClient::listBuilds(const ListBuildsRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an ListBuildsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets a list of build IDs, with each build ID representing a single
[slot] ListBuildsForProjectResponse *CodeBuildClient::listBuildsForProject(const ListBuildsForProjectRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an ListBuildsForProjectResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets a list of build IDs for the specified build project, with each build ID representing a single
[slot] ListCuratedEnvironmentImagesResponse *CodeBuildClient::listCuratedEnvironmentImages(const ListCuratedEnvironmentImagesRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an ListCuratedEnvironmentImagesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets information about Docker images that are managed by AWS
[slot] ListProjectsResponse *CodeBuildClient::listProjects(const ListProjectsRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an ListProjectsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets a list of build project names, with each build project name representing a single build
[slot] StartBuildResponse *CodeBuildClient::startBuild(const StartBuildRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an StartBuildResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Starts running a
[slot] StopBuildResponse *CodeBuildClient::stopBuild(const StopBuildRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an StopBuildResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Attempts to stop running a
[slot] UpdateProjectResponse *CodeBuildClient::updateProject(const UpdateProjectRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an UpdateProjectResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Changes the settings of a build
[slot] UpdateWebhookResponse *CodeBuildClient::updateWebhook(const UpdateWebhookRequest &request)
Sends request to the CodeBuildClient service, and returns a pointer to an UpdateWebhookResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Updates the webhook associated with an AWS CodeBuild build project.
© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.