Class CreatePullRequestApprovalRuleRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.codecommit.model.CodeCommitRequest
-
- software.amazon.awssdk.services.codecommit.model.CreatePullRequestApprovalRuleRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreatePullRequestApprovalRuleRequest.Builder,CreatePullRequestApprovalRuleRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePullRequestApprovalRuleRequest extends CodeCommitRequest implements ToCopyableBuilder<CreatePullRequestApprovalRuleRequest.Builder,CreatePullRequestApprovalRuleRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreatePullRequestApprovalRuleRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringapprovalRuleContent()The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any.StringapprovalRuleName()The name for the approval rule.static CreatePullRequestApprovalRuleRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringpullRequestId()The system-generated ID of the pull request for which you want to create the approval rule.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreatePullRequestApprovalRuleRequest.Builder>serializableBuilderClass()CreatePullRequestApprovalRuleRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
pullRequestId
public final String pullRequestId()
The system-generated ID of the pull request for which you want to create the approval rule.
- Returns:
- The system-generated ID of the pull request for which you want to create the approval rule.
-
approvalRuleName
public final String approvalRuleName()
The name for the approval rule.
- Returns:
- The name for the approval rule.
-
approvalRuleContent
public final String approvalRuleContent()
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 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 Amazon Web Services 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 Amazon Web Services 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.
- Returns:
- 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
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 Amazon Web Services 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 Amazon Web Services 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.
-
-
-
toBuilder
public CreatePullRequestApprovalRuleRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreatePullRequestApprovalRuleRequest.Builder,CreatePullRequestApprovalRuleRequest>- Specified by:
toBuilderin classCodeCommitRequest
-
builder
public static CreatePullRequestApprovalRuleRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreatePullRequestApprovalRuleRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-