Class UpdatePullRequestApprovalRuleContentRequest

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.UpdatePullRequestApprovalRuleContentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdatePullRequestApprovalRuleContentRequest.Builder,UpdatePullRequestApprovalRuleContentRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdatePullRequestApprovalRuleContentRequest extends CodeCommitRequest implements ToCopyableBuilder<UpdatePullRequestApprovalRuleContentRequest.Builder,UpdatePullRequestApprovalRuleContentRequest>

  • Method Details

    • pullRequestId

      public final String pullRequestId()

      The system-generated ID of the pull request.

      Returns:
      The system-generated ID of the pull request.

    • approvalRuleName

      public final String approvalRuleName()

      The name of the approval rule you want to update.

      Returns:
      The name of the approval rule you want to update.

    • existingRuleContentSha256

      public final String existingRuleContentSha256()

      The SHA-256 hash signature for the content of the approval rule. You can retrieve this information by using GetPullRequest.

      Returns:
      The SHA-256 hash signature for the content of the approval rule. You can retrieve this information by using GetPullRequest.

    • newRuleContent

      public final String newRuleContent()

      The updated content for the approval rule.

      When you update 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 are 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 updated content for the approval rule.

      When you update 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 are 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 UpdatePullRequestApprovalRuleContentRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdatePullRequestApprovalRuleContentRequest.Builder,UpdatePullRequestApprovalRuleContentRequest>
      Specified by:
      toBuilder in class CodeCommitRequest
      Returns:
      a builder for type T

    • builder

      public static UpdatePullRequestApprovalRuleContentRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdatePullRequestApprovalRuleContentRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.