Class PullRequestBuildPolicy

java.lang.Object
software.amazon.awssdk.services.codebuild.model.PullRequestBuildPolicy
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PullRequestBuildPolicy.Builder,PullRequestBuildPolicy>
@Generated("software.amazon.awssdk:codegen") public final class PullRequestBuildPolicy extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PullRequestBuildPolicy.Builder,PullRequestBuildPolicy>

A PullRequestBuildPolicy object that defines comment-based approval requirements for triggering builds on pull requests. This policy helps control when automated builds are executed based on contributor permissions and approval workflows.

See Also:

  • Method Details

    • requiresCommentApproval

      public final PullRequestBuildCommentApproval requiresCommentApproval()

      Specifies when comment-based approval is required before triggering a build on pull requests. This setting determines whether builds run automatically or require explicit approval through comments.

      • DISABLED: Builds trigger automatically without requiring comment approval

      • ALL_PULL_REQUESTS: All pull requests require comment approval before builds execute (unless contributor is one of the approver roles)

      • FORK_PULL_REQUESTS: Only pull requests from forked repositories require comment approval (unless contributor is one of the approver roles)

      If the service returns an enum value that is not available in the current SDK version, requiresCommentApproval will return PullRequestBuildCommentApproval.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requiresCommentApprovalAsString().

      Returns:
      Specifies when comment-based approval is required before triggering a build on pull requests. This setting determines whether builds run automatically or require explicit approval through comments.

      • DISABLED: Builds trigger automatically without requiring comment approval

      • ALL_PULL_REQUESTS: All pull requests require comment approval before builds execute (unless contributor is one of the approver roles)

      • FORK_PULL_REQUESTS: Only pull requests from forked repositories require comment approval (unless contributor is one of the approver roles)

      See Also:

    • requiresCommentApprovalAsString

      public final String requiresCommentApprovalAsString()

      Specifies when comment-based approval is required before triggering a build on pull requests. This setting determines whether builds run automatically or require explicit approval through comments.

      • DISABLED: Builds trigger automatically without requiring comment approval

      • ALL_PULL_REQUESTS: All pull requests require comment approval before builds execute (unless contributor is one of the approver roles)

      • FORK_PULL_REQUESTS: Only pull requests from forked repositories require comment approval (unless contributor is one of the approver roles)

      If the service returns an enum value that is not available in the current SDK version, requiresCommentApproval will return PullRequestBuildCommentApproval.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requiresCommentApprovalAsString().

      Returns:
      Specifies when comment-based approval is required before triggering a build on pull requests. This setting determines whether builds run automatically or require explicit approval through comments.

      • DISABLED: Builds trigger automatically without requiring comment approval

      • ALL_PULL_REQUESTS: All pull requests require comment approval before builds execute (unless contributor is one of the approver roles)

      • FORK_PULL_REQUESTS: Only pull requests from forked repositories require comment approval (unless contributor is one of the approver roles)

      See Also:

    • approverRoles

      public final List<PullRequestBuildApproverRole> approverRoles()

      List of repository roles that have approval privileges for pull request builds when comment approval is required. Only users with these roles can provide valid comment approvals. If a pull request contributor is one of these roles, their pull request builds will trigger automatically. This field is only applicable when requiresCommentApproval is not DISABLED.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasApproverRoles() method.

      Returns:
      List of repository roles that have approval privileges for pull request builds when comment approval is required. Only users with these roles can provide valid comment approvals. If a pull request contributor is one of these roles, their pull request builds will trigger automatically. This field is only applicable when requiresCommentApproval is not DISABLED.

    • hasApproverRoles

      public final boolean hasApproverRoles()
      For responses, this returns true if the service returned a value for the ApproverRoles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • approverRolesAsStrings

      public final List<String> approverRolesAsStrings()

      List of repository roles that have approval privileges for pull request builds when comment approval is required. Only users with these roles can provide valid comment approvals. If a pull request contributor is one of these roles, their pull request builds will trigger automatically. This field is only applicable when requiresCommentApproval is not DISABLED.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasApproverRoles() method.

      Returns:
      List of repository roles that have approval privileges for pull request builds when comment approval is required. Only users with these roles can provide valid comment approvals. If a pull request contributor is one of these roles, their pull request builds will trigger automatically. This field is only applicable when requiresCommentApproval is not DISABLED.

    • toBuilder

      public PullRequestBuildPolicy.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<PullRequestBuildPolicy.Builder,PullRequestBuildPolicy>
      Returns:
      a builder for type T

    • builder

      public static PullRequestBuildPolicy.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.