java.lang.Object
software.amazon.awssdk.services.codecommit.model.PullRequest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PullRequest.Builder,PullRequest>

@Generated("software.amazon.awssdk:codegen") public final class PullRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PullRequest.Builder,PullRequest>

Returns information about a pull request.

See Also:
  • Method Details

    • pullRequestId

      public final String pullRequestId()

      The system-generated ID of the pull request.

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

      public final String title()

      The user-defined title of the pull request. This title is displayed in the list of pull requests to other repository users.

      Returns:
      The user-defined title of the pull request. This title is displayed in the list of pull requests to other repository users.
    • description

      public final String description()

      The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.

      Returns:
      The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.
    • lastActivityDate

      public final Instant lastActivityDate()

      The day and time of the last user or system activity on the pull request, in timestamp format.

      Returns:
      The day and time of the last user or system activity on the pull request, in timestamp format.
    • creationDate

      public final Instant creationDate()

      The date and time the pull request was originally created, in timestamp format.

      Returns:
      The date and time the pull request was originally created, in timestamp format.
    • pullRequestStatus

      public final PullRequestStatusEnum pullRequestStatus()

      The status of the pull request. Pull request status can only change from OPEN to CLOSED .

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

      Returns:
      The status of the pull request. Pull request status can only change from OPEN to CLOSED.
      See Also:
    • pullRequestStatusAsString

      public final String pullRequestStatusAsString()

      The status of the pull request. Pull request status can only change from OPEN to CLOSED .

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

      Returns:
      The status of the pull request. Pull request status can only change from OPEN to CLOSED.
      See Also:
    • authorArn

      public final String authorArn()

      The Amazon Resource Name (ARN) of the user who created the pull request.

      Returns:
      The Amazon Resource Name (ARN) of the user who created the pull request.
    • hasPullRequestTargets

      public final boolean hasPullRequestTargets()
      For responses, this returns true if the service returned a value for the PullRequestTargets 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.
    • pullRequestTargets

      public final List<PullRequestTarget> pullRequestTargets()

      The targets of the pull request, including the source branch and destination branch for the pull request.

      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 hasPullRequestTargets() method.

      Returns:
      The targets of the pull request, including the source branch and destination branch for the pull request.
    • clientRequestToken

      public final String clientRequestToken()

      A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.

      Returns:
      A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.
    • revisionId

      public final String revisionId()

      The system-generated revision ID for the pull request.

      Returns:
      The system-generated revision ID for the pull request.
    • hasApprovalRules

      public final boolean hasApprovalRules()
      For responses, this returns true if the service returned a value for the ApprovalRules 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.
    • approvalRules

      public final List<ApprovalRule> approvalRules()

      The approval rules applied to the pull request.

      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 hasApprovalRules() method.

      Returns:
      The approval rules applied to the pull request.
    • toBuilder

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

      public static PullRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends PullRequest.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.