AWS SDK for C++  1.8.100
AWS SDK for C++
Public Member Functions | List of all members
Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest Class Reference

#include <CreatePullRequestApprovalRuleRequest.h>

+ Inheritance diagram for Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest:

Public Member Functions

 CreatePullRequestApprovalRuleRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetPullRequestId () const
 
bool PullRequestIdHasBeenSet () const
 
void SetPullRequestId (const Aws::String &value)
 
void SetPullRequestId (Aws::String &&value)
 
void SetPullRequestId (const char *value)
 
CreatePullRequestApprovalRuleRequestWithPullRequestId (const Aws::String &value)
 
CreatePullRequestApprovalRuleRequestWithPullRequestId (Aws::String &&value)
 
CreatePullRequestApprovalRuleRequestWithPullRequestId (const char *value)
 
const Aws::StringGetApprovalRuleName () const
 
bool ApprovalRuleNameHasBeenSet () const
 
void SetApprovalRuleName (const Aws::String &value)
 
void SetApprovalRuleName (Aws::String &&value)
 
void SetApprovalRuleName (const char *value)
 
CreatePullRequestApprovalRuleRequestWithApprovalRuleName (const Aws::String &value)
 
CreatePullRequestApprovalRuleRequestWithApprovalRuleName (Aws::String &&value)
 
CreatePullRequestApprovalRuleRequestWithApprovalRuleName (const char *value)
 
const Aws::StringGetApprovalRuleContent () const
 
bool ApprovalRuleContentHasBeenSet () const
 
void SetApprovalRuleContent (const Aws::String &value)
 
void SetApprovalRuleContent (Aws::String &&value)
 
void SetApprovalRuleContent (const char *value)
 
CreatePullRequestApprovalRuleRequestWithApprovalRuleContent (const Aws::String &value)
 
CreatePullRequestApprovalRuleRequestWithApprovalRuleContent (Aws::String &&value)
 
CreatePullRequestApprovalRuleRequestWithApprovalRuleContent (const char *value)
 
- Public Member Functions inherited from Aws::CodeCommit::CodeCommitRequest
virtual ~CodeCommitRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 21 of file CreatePullRequestApprovalRuleRequest.h.

Constructor & Destructor Documentation

◆ CreatePullRequestApprovalRuleRequest()

Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::CreatePullRequestApprovalRuleRequest ( )

Member Function Documentation

◆ ApprovalRuleContentHasBeenSet()

bool Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::ApprovalRuleContentHasBeenSet ( ) const
inline

The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information about approval pools, see the AWS CodeCommit User Guide.

When you create the content of the approval rule, you can specify approvers in an approval pool in one of two ways:

  • CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following would be counted as approvals coming from that user:

    • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

    • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

  • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

Definition at line 179 of file CreatePullRequestApprovalRuleRequest.h.

◆ ApprovalRuleNameHasBeenSet()

bool Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::ApprovalRuleNameHasBeenSet ( ) const
inline

The name for the approval rule.

Definition at line 94 of file CreatePullRequestApprovalRuleRequest.h.

◆ GetApprovalRuleContent()

const Aws::String& Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::GetApprovalRuleContent ( ) const
inline

The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information about approval pools, see the AWS CodeCommit User Guide.

When you create the content of the approval rule, you can specify approvers in an approval pool in one of two ways:

  • CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following would be counted as approvals coming from that user:

    • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

    • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

  • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

Definition at line 152 of file CreatePullRequestApprovalRuleRequest.h.

◆ GetApprovalRuleName()

const Aws::String& Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::GetApprovalRuleName ( ) const
inline

The name for the approval rule.

Definition at line 89 of file CreatePullRequestApprovalRuleRequest.h.

◆ GetPullRequestId()

const Aws::String& Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::GetPullRequestId ( ) const
inline

The system-generated ID of the pull request for which you want to create the approval rule.

Definition at line 41 of file CreatePullRequestApprovalRuleRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ PullRequestIdHasBeenSet()

bool Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::PullRequestIdHasBeenSet ( ) const
inline

The system-generated ID of the pull request for which you want to create the approval rule.

Definition at line 47 of file CreatePullRequestApprovalRuleRequest.h.

◆ SerializePayload()

Aws::String Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApprovalRuleContent() [1/3]

void Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::SetApprovalRuleContent ( const Aws::String value)
inline

The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information about approval pools, see the AWS CodeCommit User Guide.

When you create the content of the approval rule, you can specify approvers in an approval pool in one of two ways:

  • CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following would be counted as approvals coming from that user:

    • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

    • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

  • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

Definition at line 206 of file CreatePullRequestApprovalRuleRequest.h.

◆ SetApprovalRuleContent() [2/3]

void Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::SetApprovalRuleContent ( Aws::String &&  value)
inline

The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information about approval pools, see the AWS CodeCommit User Guide.

When you create the content of the approval rule, you can specify approvers in an approval pool in one of two ways:

  • CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following would be counted as approvals coming from that user:

    • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

    • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

  • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

Definition at line 233 of file CreatePullRequestApprovalRuleRequest.h.

◆ SetApprovalRuleContent() [3/3]

void Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::SetApprovalRuleContent ( const char *  value)
inline

The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information about approval pools, see the AWS CodeCommit User Guide.

When you create the content of the approval rule, you can specify approvers in an approval pool in one of two ways:

  • CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following would be counted as approvals coming from that user:

    • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

    • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

  • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

Definition at line 260 of file CreatePullRequestApprovalRuleRequest.h.

◆ SetApprovalRuleName() [1/3]

void Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::SetApprovalRuleName ( const Aws::String value)
inline

The name for the approval rule.

Definition at line 99 of file CreatePullRequestApprovalRuleRequest.h.

◆ SetApprovalRuleName() [2/3]

void Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::SetApprovalRuleName ( Aws::String &&  value)
inline

The name for the approval rule.

Definition at line 104 of file CreatePullRequestApprovalRuleRequest.h.

◆ SetApprovalRuleName() [3/3]

void Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::SetApprovalRuleName ( const char *  value)
inline

The name for the approval rule.

Definition at line 109 of file CreatePullRequestApprovalRuleRequest.h.

◆ SetPullRequestId() [1/3]

void Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::SetPullRequestId ( const Aws::String value)
inline

The system-generated ID of the pull request for which you want to create the approval rule.

Definition at line 53 of file CreatePullRequestApprovalRuleRequest.h.

◆ SetPullRequestId() [2/3]

void Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::SetPullRequestId ( Aws::String &&  value)
inline

The system-generated ID of the pull request for which you want to create the approval rule.

Definition at line 59 of file CreatePullRequestApprovalRuleRequest.h.

◆ SetPullRequestId() [3/3]

void Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::SetPullRequestId ( const char *  value)
inline

The system-generated ID of the pull request for which you want to create the approval rule.

Definition at line 65 of file CreatePullRequestApprovalRuleRequest.h.

◆ WithApprovalRuleContent() [1/3]

CreatePullRequestApprovalRuleRequest& Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::WithApprovalRuleContent ( const Aws::String value)
inline

The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information about approval pools, see the AWS CodeCommit User Guide.

When you create the content of the approval rule, you can specify approvers in an approval pool in one of two ways:

  • CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following would be counted as approvals coming from that user:

    • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

    • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

  • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

Definition at line 287 of file CreatePullRequestApprovalRuleRequest.h.

◆ WithApprovalRuleContent() [2/3]

CreatePullRequestApprovalRuleRequest& Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::WithApprovalRuleContent ( Aws::String &&  value)
inline

The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information about approval pools, see the AWS CodeCommit User Guide.

When you create the content of the approval rule, you can specify approvers in an approval pool in one of two ways:

  • CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following would be counted as approvals coming from that user:

    • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

    • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

  • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

Definition at line 314 of file CreatePullRequestApprovalRuleRequest.h.

◆ WithApprovalRuleContent() [3/3]

CreatePullRequestApprovalRuleRequest& Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::WithApprovalRuleContent ( const char *  value)
inline

The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information about approval pools, see the AWS CodeCommit User Guide.

When you create the content of the approval rule, you can specify approvers in an approval pool in one of two ways:

  • CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following would be counted as approvals coming from that user:

    • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

    • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

  • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

Definition at line 341 of file CreatePullRequestApprovalRuleRequest.h.

◆ WithApprovalRuleName() [1/3]

CreatePullRequestApprovalRuleRequest& Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::WithApprovalRuleName ( const Aws::String value)
inline

The name for the approval rule.

Definition at line 114 of file CreatePullRequestApprovalRuleRequest.h.

◆ WithApprovalRuleName() [2/3]

CreatePullRequestApprovalRuleRequest& Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::WithApprovalRuleName ( Aws::String &&  value)
inline

The name for the approval rule.

Definition at line 119 of file CreatePullRequestApprovalRuleRequest.h.

◆ WithApprovalRuleName() [3/3]

CreatePullRequestApprovalRuleRequest& Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::WithApprovalRuleName ( const char *  value)
inline

The name for the approval rule.

Definition at line 124 of file CreatePullRequestApprovalRuleRequest.h.

◆ WithPullRequestId() [1/3]

CreatePullRequestApprovalRuleRequest& Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::WithPullRequestId ( const Aws::String value)
inline

The system-generated ID of the pull request for which you want to create the approval rule.

Definition at line 71 of file CreatePullRequestApprovalRuleRequest.h.

◆ WithPullRequestId() [2/3]

CreatePullRequestApprovalRuleRequest& Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::WithPullRequestId ( Aws::String &&  value)
inline

The system-generated ID of the pull request for which you want to create the approval rule.

Definition at line 77 of file CreatePullRequestApprovalRuleRequest.h.

◆ WithPullRequestId() [3/3]

CreatePullRequestApprovalRuleRequest& Aws::CodeCommit::Model::CreatePullRequestApprovalRuleRequest::WithPullRequestId ( const char *  value)
inline

The system-generated ID of the pull request for which you want to create the approval rule.

Definition at line 83 of file CreatePullRequestApprovalRuleRequest.h.


The documentation for this class was generated from the following file: