CodeCommitClient Class
(QtAws::CodeCommit::CodeCommitClient)The CodeCommitClient class provides access to the AWS CodeCommit service. More...
| Header: | #include <CodeCommitClient> |
| Inherits: | QtAws::Core::AwsAbstractClient |
Public Functions
| CodeCommitClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0) | |
| CodeCommitClient(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
| BatchGetRepositoriesResponse * | batchGetRepositories(const BatchGetRepositoriesRequest &request) |
| CreateBranchResponse * | createBranch(const CreateBranchRequest &request) |
| CreatePullRequestResponse * | createPullRequest(const CreatePullRequestRequest &request) |
| CreateRepositoryResponse * | createRepository(const CreateRepositoryRequest &request) |
| DeleteBranchResponse * | deleteBranch(const DeleteBranchRequest &request) |
| DeleteCommentContentResponse * | deleteCommentContent(const DeleteCommentContentRequest &request) |
| DeleteRepositoryResponse * | deleteRepository(const DeleteRepositoryRequest &request) |
| DescribePullRequestEventsResponse * | describePullRequestEvents(const DescribePullRequestEventsRequest &request) |
| GetBlobResponse * | getBlob(const GetBlobRequest &request) |
| GetBranchResponse * | getBranch(const GetBranchRequest &request) |
| GetCommentResponse * | getComment(const GetCommentRequest &request) |
| GetCommentsForComparedCommitResponse * | getCommentsForComparedCommit(const GetCommentsForComparedCommitRequest &request) |
| GetCommentsForPullRequestResponse * | getCommentsForPullRequest(const GetCommentsForPullRequestRequest &request) |
| GetCommitResponse * | getCommit(const GetCommitRequest &request) |
| GetDifferencesResponse * | getDifferences(const GetDifferencesRequest &request) |
| GetMergeConflictsResponse * | getMergeConflicts(const GetMergeConflictsRequest &request) |
| GetPullRequestResponse * | getPullRequest(const GetPullRequestRequest &request) |
| GetRepositoryResponse * | getRepository(const GetRepositoryRequest &request) |
| GetRepositoryTriggersResponse * | getRepositoryTriggers(const GetRepositoryTriggersRequest &request) |
| ListBranchesResponse * | listBranches(const ListBranchesRequest &request) |
| ListPullRequestsResponse * | listPullRequests(const ListPullRequestsRequest &request) |
| ListRepositoriesResponse * | listRepositories(const ListRepositoriesRequest &request) |
| MergePullRequestByFastForwardResponse * | mergePullRequestByFastForward(const MergePullRequestByFastForwardRequest &request) |
| PostCommentForComparedCommitResponse * | postCommentForComparedCommit(const PostCommentForComparedCommitRequest &request) |
| PostCommentForPullRequestResponse * | postCommentForPullRequest(const PostCommentForPullRequestRequest &request) |
| PostCommentReplyResponse * | postCommentReply(const PostCommentReplyRequest &request) |
| PutFileResponse * | putFile(const PutFileRequest &request) |
| PutRepositoryTriggersResponse * | putRepositoryTriggers(const PutRepositoryTriggersRequest &request) |
| TestRepositoryTriggersResponse * | testRepositoryTriggers(const TestRepositoryTriggersRequest &request) |
| UpdateCommentResponse * | updateComment(const UpdateCommentRequest &request) |
| UpdateDefaultBranchResponse * | updateDefaultBranch(const UpdateDefaultBranchRequest &request) |
| UpdatePullRequestDescriptionResponse * | updatePullRequestDescription(const UpdatePullRequestDescriptionRequest &request) |
| UpdatePullRequestStatusResponse * | updatePullRequestStatus(const UpdatePullRequestStatusRequest &request) |
| UpdatePullRequestTitleResponse * | updatePullRequestTitle(const UpdatePullRequestTitleRequest &request) |
| UpdateRepositoryDescriptionResponse * | updateRepositoryDescription(const UpdateRepositoryDescriptionRequest &request) |
| UpdateRepositoryNameResponse * | updateRepositoryName(const UpdateRepositoryNameRequest &request) |
Additional Inherited Members
- 2 protected functions inherited from QtAws::Core::AwsAbstractClient
Detailed Description
The CodeCommitClient class provides access to the AWS CodeCommit service.
<fullname>AWS CodeCommit</fullname>
This is the <i>AWS CodeCommit API Reference</i>. This reference provides descriptions of the operations and data types for AWS CodeCommit API along with usage
examples>
You can use the AWS CodeCommit API to work with the following
objects>
Repositories, by calling the
following> <ul> <li>
<a>BatchGetRepositories</a>, which returns information about one or more repositories associated with your AWS
account> </li> <li>
<a>CreateRepository</a>, which creates an AWS CodeCommit
repository> </li> <li>
<a>DeleteRepository</a>, which deletes an AWS CodeCommit
repository> </li> <li>
<a>GetRepository</a>, which returns information about a specified
repository> </li> <li>
<a>ListRepositories</a>, which lists all AWS CodeCommit repositories associated with your AWS
account> </li> <li>
<a>UpdateRepositoryDescription</a>, which sets or updates the description of the
repository> </li> <li>
<a>UpdateRepositoryName</a>, which changes the name of the repository. If you change the name of a repository, no other users of that repository will be able to access it until you send them the new HTTPS or SSH URL to
use> </li> </ul>
Branches, by calling the
following> <ul> <li>
<a>CreateBranch</a>, which creates a new branch in a specified
repository> </li> <li>
<a>DeleteBranch</a>, which deletes the specified branch in a repository unless it is the default
branch> </li> <li>
<a>GetBranch</a>, which returns information about a specified
branch> </li> <li>
<a>ListBranches</a>, which lists all branches for a specified
repository> </li> <li>
<a>UpdateDefaultBranch</a>, which changes the default branch for a
repository> </li> </ul>
Files, by calling the
following> <ul> <li>
<a>PutFile</a>, which adds or modifies a file in a specified repository and
branch> </li> </ul>
Information about committed code in a repository, by calling the
following> <ul> <li>
<a>GetBlob</a>, which returns the base-64 encoded content of an individual Git blob object within a
repository> </li> <li>
<a>GetCommit</a>, which returns information about a commit, including commit messages and author and committer
information> </li> <li>
<a>GetDifferences</a>, which returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified
reference)> </li> </ul>
Pull requests, by calling the
following> <ul> <li>
<a>CreatePullRequest</a>, which creates a pull request in a specified
repository> </li> <li>
<a>DescribePullRequestEvents</a>, which returns information about one or more pull request
events> </li> <li>
<a>GetCommentsForPullRequest</a>, which returns information about comments on a specified pull
request> </li> <li>
<a>GetMergeConflicts</a>, which returns information about merge conflicts between the source and destination branch in a pull
request> </li> <li>
<a>GetPullRequest</a>, which returns information about a specified pull
request> </li> <li>
<a>ListPullRequests</a>, which lists all pull requests for a
repository> </li> <li>
<a>MergePullRequestByFastForward</a>, which merges the source destination branch of a pull request into the specified destination branch for that pull request using the fast-forward merge
option> </li> <li>
<a>PostCommentForPullRequest</a>, which posts a comment to a pull request at the specified line, file, or
request> </li> <li>
<a>UpdatePullRequestDescription</a>, which updates the description of a pull
request> </li> <li>
<a>UpdatePullRequestStatus</a>, which updates the status of a pull
request> </li> <li>
<a>UpdatePullRequestTitle</a>, which updates the title of a pull
request> </li> </ul>
Information about comments in a repository, by calling the
following> <ul> <li>
<a>DeleteCommentContent</a>, which deletes the content of a comment on a commit in a
repository> </li> <li>
<a>GetComment</a>, which returns information about a comment on a
commit> </li> <li>
<a>GetCommentsForComparedCommit</a>, which returns information about comments on the comparison between two commit specifiers in a
repository> </li> <li>
<a>PostCommentForComparedCommit</a>, which creates a comment on the comparison between two commit specifiers in a
repository> </li> <li>
<a>PostCommentReply</a>, which creates a reply to a
comment> </li> <li>
<a>UpdateComment</a>, which updates the content of a comment on a commit in a
repository> </li> </ul>
Triggers, by calling the
following> <ul> <li>
<a>GetRepositoryTriggers</a>, which returns information about triggers configured for a
repository> </li> <li>
<a>PutRepositoryTriggers</a>, which replaces all triggers for a repository and can be used to create or delete
triggers> </li> <li>
<a>TestRepositoryTriggers</a>, which tests the functionality of a repository trigger by sending data to the trigger
target> </li> </ul>
For information about how to use AWS CodeCommit, see the <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">AWS CodeCommit User
Member Function Documentation
CodeCommitClient::CodeCommitClient(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 CodeCommitClient object.
The new client object will region, credentials, and manager for network operations.
The new object will be owned by parent, if set.
CodeCommitClient::CodeCommitClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
This function overloads CodeCommitClient().
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] BatchGetRepositoriesResponse *CodeCommitClient::batchGetRepositories(const BatchGetRepositoriesRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an BatchGetRepositoriesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns information about one or more
repositories> <note>
The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web
[slot] CreateBranchResponse *CodeCommitClient::createBranch(const CreateBranchRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an CreateBranchResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Creates a new branch in a repository and points the branch to a
commit> <note>
Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch
[slot] CreatePullRequestResponse *CodeCommitClient::createPullRequest(const CreatePullRequestRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an CreatePullRequestResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Creates a pull request in the specified
[slot] CreateRepositoryResponse *CodeCommitClient::createRepository(const CreateRepositoryRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an CreateRepositoryResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Creates a new, empty
[slot] DeleteBranchResponse *CodeCommitClient::deleteBranch(const DeleteBranchRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an DeleteBranchResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes a branch from a repository, unless that branch is the default branch for the repository.
[slot] DeleteCommentContentResponse *CodeCommitClient::deleteCommentContent(const DeleteCommentContentRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an DeleteCommentContentResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes the content of a comment made on a change, file, or commit in a
[slot] DeleteRepositoryResponse *CodeCommitClient::deleteRepository(const DeleteRepositoryRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an DeleteRepositoryResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes a repository. If a specified repository was already deleted, a null repository ID will be
returned> <b>
Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will
[slot] DescribePullRequestEventsResponse *CodeCommitClient::describePullRequestEvents(const DescribePullRequestEventsRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an DescribePullRequestEventsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns information about one or more pull request
[slot] GetBlobResponse *CodeCommitClient::getBlob(const GetBlobRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an GetBlobResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns the base-64 encoded content of an individual blob within a
[slot] GetBranchResponse *CodeCommitClient::getBranch(const GetBranchRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an GetBranchResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns information about a repository branch, including its name and the last commit
[slot] GetCommentResponse *CodeCommitClient::getComment(const GetCommentRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an GetCommentResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns the content of a comment made on a change, file, or commit in a
[slot] GetCommentsForComparedCommitResponse *CodeCommitClient::getCommentsForComparedCommit(const GetCommentsForComparedCommitRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an GetCommentsForComparedCommitResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns information about comments made on the comparison between two
[slot] GetCommentsForPullRequestResponse *CodeCommitClient::getCommentsForPullRequest(const GetCommentsForPullRequestRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an GetCommentsForPullRequestResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns comments made on a pull
[slot] GetCommitResponse *CodeCommitClient::getCommit(const GetCommitRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an GetCommitResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns information about a commit, including commit message and committer
[slot] GetDifferencesResponse *CodeCommitClient::getDifferences(const GetDifferencesRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an GetDifferencesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference). Results can be limited to a specified
[slot] GetMergeConflictsResponse *CodeCommitClient::getMergeConflicts(const GetMergeConflictsRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an GetMergeConflictsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns information about merge conflicts between the before and after commit IDs for a pull request in a
[slot] GetPullRequestResponse *CodeCommitClient::getPullRequest(const GetPullRequestRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an GetPullRequestResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets information about a pull request in a specified
[slot] GetRepositoryResponse *CodeCommitClient::getRepository(const GetRepositoryRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an GetRepositoryResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns information about a
repository> <note>
The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web
[slot] GetRepositoryTriggersResponse *CodeCommitClient::getRepositoryTriggers(const GetRepositoryTriggersRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an GetRepositoryTriggersResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets information about triggers configured for a
[slot] ListBranchesResponse *CodeCommitClient::listBranches(const ListBranchesRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an ListBranchesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets information about one or more branches in a
[slot] ListPullRequestsResponse *CodeCommitClient::listPullRequests(const ListPullRequestsRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an ListPullRequestsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Returns a list of pull requests for a specified repository. The return list can be refined by pull request status or pull request author
[slot] ListRepositoriesResponse *CodeCommitClient::listRepositories(const ListRepositoriesRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an ListRepositoriesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets information about one or more
[slot] MergePullRequestByFastForwardResponse *CodeCommitClient::mergePullRequestByFastForward(const MergePullRequestByFastForwardRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an MergePullRequestByFastForwardResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Closes a pull request and attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the fast-forward merge
[slot] PostCommentForComparedCommitResponse *CodeCommitClient::postCommentForComparedCommit(const PostCommentForComparedCommitRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an PostCommentForComparedCommitResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Posts a comment on the comparison between two
[slot] PostCommentForPullRequestResponse *CodeCommitClient::postCommentForPullRequest(const PostCommentForPullRequestRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an PostCommentForPullRequestResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Posts a comment on a pull
[slot] PostCommentReplyResponse *CodeCommitClient::postCommentReply(const PostCommentReplyRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an PostCommentReplyResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Posts a comment in reply to an existing comment on a comparison between commits or a pull
[slot] PutFileResponse *CodeCommitClient::putFile(const PutFileRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an PutFileResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Adds or updates a file in an AWS CodeCommit
[slot] PutRepositoryTriggersResponse *CodeCommitClient::putRepositoryTriggers(const PutRepositoryTriggersRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an PutRepositoryTriggersResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Replaces all triggers for a repository. This can be used to create or delete
[slot] TestRepositoryTriggersResponse *CodeCommitClient::testRepositoryTriggers(const TestRepositoryTriggersRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an TestRepositoryTriggersResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Tests the functionality of repository triggers by sending information to the trigger target. If real data is available in the repository, the test will send data from the last commit. If no data is available, sample data will be
[slot] UpdateCommentResponse *CodeCommitClient::updateComment(const UpdateCommentRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an UpdateCommentResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Replaces the contents of a
[slot] UpdateDefaultBranchResponse *CodeCommitClient::updateDefaultBranch(const UpdateDefaultBranchRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an UpdateDefaultBranchResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Sets or changes the default branch name for the specified
repository> <note>
If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not
[slot] UpdatePullRequestDescriptionResponse *CodeCommitClient::updatePullRequestDescription(const UpdatePullRequestDescriptionRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an UpdatePullRequestDescriptionResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Replaces the contents of the description of a pull
[slot] UpdatePullRequestStatusResponse *CodeCommitClient::updatePullRequestStatus(const UpdatePullRequestStatusRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an UpdatePullRequestStatusResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Updates the status of a pull request.
[slot] UpdatePullRequestTitleResponse *CodeCommitClient::updatePullRequestTitle(const UpdatePullRequestTitleRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an UpdatePullRequestTitleResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Replaces the title of a pull
[slot] UpdateRepositoryDescriptionResponse *CodeCommitClient::updateRepositoryDescription(const UpdateRepositoryDescriptionRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an UpdateRepositoryDescriptionResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Sets or changes the comment or description for a
repository> <note>
The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web
[slot] UpdateRepositoryNameResponse *CodeCommitClient::updateRepositoryName(const UpdateRepositoryNameRequest &request)
Sends request to the CodeCommitClient service, and returns a pointer to an UpdateRepositoryNameResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Renames a repository. The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. The suffix ".git" is prohibited. For a full description of the limits on repository names, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/limits.html">Limits</a> in the AWS CodeCommit User
© 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.