CodeCommitRequest Class

(QtAws::CodeCommit::CodeCommitRequest)

The CodeCommitRequest class provides an interface for CodeCommit requests. More...

Header: #include <CodeCommitRequest>
Inherits: QtAws::Core::AwsAbstractRequest
Inherited By:

QtAws::CodeCommit::BatchGetRepositoriesRequest, QtAws::CodeCommit::CreateBranchRequest, QtAws::CodeCommit::CreatePullRequestRequest, QtAws::CodeCommit::CreateRepositoryRequest, QtAws::CodeCommit::DeleteBranchRequest, QtAws::CodeCommit::DeleteCommentContentRequest, QtAws::CodeCommit::DeleteRepositoryRequest, QtAws::CodeCommit::DescribePullRequestEventsRequest, QtAws::CodeCommit::GetBlobRequest, QtAws::CodeCommit::GetBranchRequest, QtAws::CodeCommit::GetCommentRequest, QtAws::CodeCommit::GetCommentsForComparedCommitRequest, QtAws::CodeCommit::GetCommentsForPullRequestRequest, QtAws::CodeCommit::GetCommitRequest, QtAws::CodeCommit::GetDifferencesRequest, QtAws::CodeCommit::GetMergeConflictsRequest, QtAws::CodeCommit::GetPullRequestRequest, QtAws::CodeCommit::GetRepositoryRequest, QtAws::CodeCommit::GetRepositoryTriggersRequest, QtAws::CodeCommit::ListBranchesRequest, QtAws::CodeCommit::ListPullRequestsRequest, QtAws::CodeCommit::ListRepositoriesRequest, QtAws::CodeCommit::MergePullRequestByFastForwardRequest, QtAws::CodeCommit::PostCommentForComparedCommitRequest, QtAws::CodeCommit::PostCommentForPullRequestRequest, QtAws::CodeCommit::PostCommentReplyRequest, QtAws::CodeCommit::PutFileRequest, QtAws::CodeCommit::PutRepositoryTriggersRequest, QtAws::CodeCommit::TestRepositoryTriggersRequest, QtAws::CodeCommit::UpdateCommentRequest, QtAws::CodeCommit::UpdateDefaultBranchRequest, QtAws::CodeCommit::UpdatePullRequestDescriptionRequest, QtAws::CodeCommit::UpdatePullRequestStatusRequest, QtAws::CodeCommit::UpdatePullRequestTitleRequest, QtAws::CodeCommit::UpdateRepositoryDescriptionRequest, and QtAws::CodeCommit::UpdateRepositoryNameRequest

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

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 &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

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.

ConstantValueDescription
QtAws::CodeCommit::CodeCommitRequest::BatchGetRepositoriesAction0CodeCommit BatchGetRepositories action.
QtAws::CodeCommit::CodeCommitRequest::CreateBranchAction1CodeCommit CreateBranch action.
QtAws::CodeCommit::CodeCommitRequest::CreatePullRequestAction2CodeCommit CreatePullRequest action.
QtAws::CodeCommit::CodeCommitRequest::CreateRepositoryAction3CodeCommit CreateRepository action.
QtAws::CodeCommit::CodeCommitRequest::DeleteBranchAction4CodeCommit DeleteBranch action.
QtAws::CodeCommit::CodeCommitRequest::DeleteCommentContentAction5CodeCommit DeleteCommentContent action.
QtAws::CodeCommit::CodeCommitRequest::DeleteRepositoryAction6CodeCommit DeleteRepository action.
QtAws::CodeCommit::CodeCommitRequest::DescribePullRequestEventsAction7CodeCommit DescribePullRequestEvents action.
QtAws::CodeCommit::CodeCommitRequest::GetBlobAction8CodeCommit GetBlob action.
QtAws::CodeCommit::CodeCommitRequest::GetBranchAction9CodeCommit GetBranch action.
QtAws::CodeCommit::CodeCommitRequest::GetCommentAction10CodeCommit GetComment action.
QtAws::CodeCommit::CodeCommitRequest::GetCommentsForComparedCommitAction11CodeCommit GetCommentsForComparedCommit action.
QtAws::CodeCommit::CodeCommitRequest::GetCommentsForPullRequestAction12CodeCommit GetCommentsForPullRequest action.
QtAws::CodeCommit::CodeCommitRequest::GetCommitAction13CodeCommit GetCommit action.
QtAws::CodeCommit::CodeCommitRequest::GetDifferencesAction14CodeCommit GetDifferences action.
QtAws::CodeCommit::CodeCommitRequest::GetMergeConflictsAction15CodeCommit GetMergeConflicts action.
QtAws::CodeCommit::CodeCommitRequest::GetPullRequestAction16CodeCommit GetPullRequest action.
QtAws::CodeCommit::CodeCommitRequest::GetRepositoryAction17CodeCommit GetRepository action.
QtAws::CodeCommit::CodeCommitRequest::GetRepositoryTriggersAction18CodeCommit GetRepositoryTriggers action.
QtAws::CodeCommit::CodeCommitRequest::ListBranchesAction19CodeCommit ListBranches action.
QtAws::CodeCommit::CodeCommitRequest::ListPullRequestsAction20CodeCommit ListPullRequests action.
QtAws::CodeCommit::CodeCommitRequest::ListRepositoriesAction21CodeCommit ListRepositories action.
QtAws::CodeCommit::CodeCommitRequest::MergePullRequestByFastForwardAction22CodeCommit MergePullRequestByFastForward action.
QtAws::CodeCommit::CodeCommitRequest::PostCommentForComparedCommitAction23CodeCommit PostCommentForComparedCommit action.
QtAws::CodeCommit::CodeCommitRequest::PostCommentForPullRequestAction24CodeCommit PostCommentForPullRequest action.
QtAws::CodeCommit::CodeCommitRequest::PostCommentReplyAction25CodeCommit PostCommentReply action.
QtAws::CodeCommit::CodeCommitRequest::PutFileAction26CodeCommit PutFile action.
QtAws::CodeCommit::CodeCommitRequest::PutRepositoryTriggersAction27CodeCommit PutRepositoryTriggers action.
QtAws::CodeCommit::CodeCommitRequest::TestRepositoryTriggersAction28CodeCommit TestRepositoryTriggers action.
QtAws::CodeCommit::CodeCommitRequest::UpdateCommentAction29CodeCommit UpdateComment action.
QtAws::CodeCommit::CodeCommitRequest::UpdateDefaultBranchAction30CodeCommit UpdateDefaultBranch action.
QtAws::CodeCommit::CodeCommitRequest::UpdatePullRequestDescriptionAction31CodeCommit UpdatePullRequestDescription action.
QtAws::CodeCommit::CodeCommitRequest::UpdatePullRequestStatusAction32CodeCommit UpdatePullRequestStatus action.
QtAws::CodeCommit::CodeCommitRequest::UpdatePullRequestTitleAction33CodeCommit UpdatePullRequestTitle action.
QtAws::CodeCommit::CodeCommitRequest::UpdateRepositoryDescriptionAction34CodeCommit UpdateRepositoryDescription action.
QtAws::CodeCommit::CodeCommitRequest::UpdateRepositoryNameAction35CodeCommit 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 &parameters)

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.