CodeCommitRequest Class
(QtAws::CodeCommit::CodeCommitRequest)The CodeCommitRequest class provides an interface for CodeCommit requests. More...
Public Types
| enum | Action { BatchGetRepositoriesAction, CreateBranchAction, CreatePullRequestAction, CreateRepositoryAction, ..., UpdateRepositoryNameAction } |
| flags | Actions |
Public Functions
| CodeCommitRequest(const Action action) | |
| CodeCommitRequest(const CodeCommitRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| CodeCommitRequest & | operator=(const CodeCommitRequest &other) |
| virtual bool | operator==(const CodeCommitRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| CodeCommitRequest(CodeCommitRequestPrivate * const d) | |
| int | clearParameter(const QString &name) |
| void | clearParameters() |
| QVariant | parameter(const QString &name, const QVariant &defaultValue = QVariant()) const |
| const QVariantMap & | parameters() const |
| void | setParameter(const QString &name, const QVariant &value) |
| void | setParameters(const QVariantMap ¶meters) |
Reimplemented Protected Functions
| virtual QNetworkRequest | unsignedRequest(const QUrl &endpoint) const override |
- 4 protected functions inherited from QtAws::Core::AwsAbstractRequest
Detailed Description
The CodeCommitRequest class provides an interface for CodeCommit requests.
Member Type Documentation
enum CodeCommitRequest::Action
flags CodeCommitRequest::Actions
This enum describes the actions that can be performed as CodeCommit requests.
| Constant | Value | Description |
|---|---|---|
QtAws::CodeCommit::CodeCommitRequest::BatchGetRepositoriesAction | 0 | CodeCommit BatchGetRepositories action. |
QtAws::CodeCommit::CodeCommitRequest::CreateBranchAction | 1 | CodeCommit CreateBranch action. |
QtAws::CodeCommit::CodeCommitRequest::CreatePullRequestAction | 2 | CodeCommit CreatePullRequest action. |
QtAws::CodeCommit::CodeCommitRequest::CreateRepositoryAction | 3 | CodeCommit CreateRepository action. |
QtAws::CodeCommit::CodeCommitRequest::DeleteBranchAction | 4 | CodeCommit DeleteBranch action. |
QtAws::CodeCommit::CodeCommitRequest::DeleteCommentContentAction | 5 | CodeCommit DeleteCommentContent action. |
QtAws::CodeCommit::CodeCommitRequest::DeleteRepositoryAction | 6 | CodeCommit DeleteRepository action. |
QtAws::CodeCommit::CodeCommitRequest::DescribePullRequestEventsAction | 7 | CodeCommit DescribePullRequestEvents action. |
QtAws::CodeCommit::CodeCommitRequest::GetBlobAction | 8 | CodeCommit GetBlob action. |
QtAws::CodeCommit::CodeCommitRequest::GetBranchAction | 9 | CodeCommit GetBranch action. |
QtAws::CodeCommit::CodeCommitRequest::GetCommentAction | 10 | CodeCommit GetComment action. |
QtAws::CodeCommit::CodeCommitRequest::GetCommentsForComparedCommitAction | 11 | CodeCommit GetCommentsForComparedCommit action. |
QtAws::CodeCommit::CodeCommitRequest::GetCommentsForPullRequestAction | 12 | CodeCommit GetCommentsForPullRequest action. |
QtAws::CodeCommit::CodeCommitRequest::GetCommitAction | 13 | CodeCommit GetCommit action. |
QtAws::CodeCommit::CodeCommitRequest::GetDifferencesAction | 14 | CodeCommit GetDifferences action. |
QtAws::CodeCommit::CodeCommitRequest::GetMergeConflictsAction | 15 | CodeCommit GetMergeConflicts action. |
QtAws::CodeCommit::CodeCommitRequest::GetPullRequestAction | 16 | CodeCommit GetPullRequest action. |
QtAws::CodeCommit::CodeCommitRequest::GetRepositoryAction | 17 | CodeCommit GetRepository action. |
QtAws::CodeCommit::CodeCommitRequest::GetRepositoryTriggersAction | 18 | CodeCommit GetRepositoryTriggers action. |
QtAws::CodeCommit::CodeCommitRequest::ListBranchesAction | 19 | CodeCommit ListBranches action. |
QtAws::CodeCommit::CodeCommitRequest::ListPullRequestsAction | 20 | CodeCommit ListPullRequests action. |
QtAws::CodeCommit::CodeCommitRequest::ListRepositoriesAction | 21 | CodeCommit ListRepositories action. |
QtAws::CodeCommit::CodeCommitRequest::MergePullRequestByFastForwardAction | 22 | CodeCommit MergePullRequestByFastForward action. |
QtAws::CodeCommit::CodeCommitRequest::PostCommentForComparedCommitAction | 23 | CodeCommit PostCommentForComparedCommit action. |
QtAws::CodeCommit::CodeCommitRequest::PostCommentForPullRequestAction | 24 | CodeCommit PostCommentForPullRequest action. |
QtAws::CodeCommit::CodeCommitRequest::PostCommentReplyAction | 25 | CodeCommit PostCommentReply action. |
QtAws::CodeCommit::CodeCommitRequest::PutFileAction | 26 | CodeCommit PutFile action. |
QtAws::CodeCommit::CodeCommitRequest::PutRepositoryTriggersAction | 27 | CodeCommit PutRepositoryTriggers action. |
QtAws::CodeCommit::CodeCommitRequest::TestRepositoryTriggersAction | 28 | CodeCommit TestRepositoryTriggers action. |
QtAws::CodeCommit::CodeCommitRequest::UpdateCommentAction | 29 | CodeCommit UpdateComment action. |
QtAws::CodeCommit::CodeCommitRequest::UpdateDefaultBranchAction | 30 | CodeCommit UpdateDefaultBranch action. |
QtAws::CodeCommit::CodeCommitRequest::UpdatePullRequestDescriptionAction | 31 | CodeCommit UpdatePullRequestDescription action. |
QtAws::CodeCommit::CodeCommitRequest::UpdatePullRequestStatusAction | 32 | CodeCommit UpdatePullRequestStatus action. |
QtAws::CodeCommit::CodeCommitRequest::UpdatePullRequestTitleAction | 33 | CodeCommit UpdatePullRequestTitle action. |
QtAws::CodeCommit::CodeCommitRequest::UpdateRepositoryDescriptionAction | 34 | CodeCommit UpdateRepositoryDescription action. |
QtAws::CodeCommit::CodeCommitRequest::UpdateRepositoryNameAction | 35 | CodeCommit UpdateRepositoryName action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
CodeCommitRequest::CodeCommitRequest(const Action action)
Constructs a CodeCommitRequest object for CodeCommit action.
CodeCommitRequest::CodeCommitRequest(const CodeCommitRequest &other)
Constructs a copy of other.
[protected] CodeCommitRequest::CodeCommitRequest(CodeCommitRequestPrivate * const d)
Constructs aa CodeCommitRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from CodeCommitRequestPrivate.
Action CodeCommitRequest::action() const
Returns the CodeCommit action to be performed by this request.
See also setAction().
QString CodeCommitRequest::actionString() const
Returns the name of the CodeCommit action to be performed by this request.
QString CodeCommitRequest::apiVersion() const
Returns the CodeCommit API version implemented by this request.
See also setApiVersion().
[protected] int CodeCommitRequest::clearParameter(const QString &name)
Removes the a name parameter from the request, then returns the number of paramters removed (typically 0 or 1).
[protected] void CodeCommitRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant CodeCommitRequest::parameter(const QString &name, const QVariant &defaultValue = QVariant()) const
Returns the value of the name pararemter if set; defaultValue otherwise.
See also setParameter().
[protected] const QVariantMap &CodeCommitRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void CodeCommitRequest::setAction(const Action action)
Sets the CodeCommit action to be performed by this request to action.
See also action().
void CodeCommitRequest::setApiVersion(const QString &version)
Sets the CodeCommit API version to include in this request to version.
See also apiVersion().
[protected] void CodeCommitRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void CodeCommitRequest::setParameters(const QVariantMap ¶meters)
Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.
See also parameters().
[override virtual protected] QNetworkRequest CodeCommitRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the CodeCommit request using the given endpoint.
This CodeCommit implementation builds request URLs by combining the common query parameters (such as Action and Version), with any that have been added (via setParameter) by child classes.
CodeCommitRequest &CodeCommitRequest::operator=(const CodeCommitRequest &other)
Sets the CodeCommitRequest object to be equal to other.
[virtual] bool CodeCommitRequest::operator==(const CodeCommitRequest &other) const
Returns true if this request is equal to other; false otherwise.
Note, most derived *Request classes do not need to provider their own implementations of this function, since most such request classes rely on this class' parameters functionality for all request parameters, and that parameters map is already checked via this implementation.
© 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.