Class DescribePullRequestEventsRequest

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

  • Method Details

    • pullRequestId

      public final String pullRequestId()

      The system-generated ID of the pull request. To get this ID, use ListPullRequests.

      Returns:
      The system-generated ID of the pull request. To get this ID, use ListPullRequests.

    • pullRequestEventType

      public final PullRequestEventType pullRequestEventType()

      Optional. The pull request event type about which you want to return information.

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

      Returns:
      Optional. The pull request event type about which you want to return information.
      See Also:

    • pullRequestEventTypeAsString

      public final String pullRequestEventTypeAsString()

      Optional. The pull request event type about which you want to return information.

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

      Returns:
      Optional. The pull request event type about which you want to return information.
      See Also:

    • actorArn

      public final String actorArn()

      The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the pull request with more commits or changing the status of a pull request.

      Returns:
      The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the pull request with more commits or changing the status of a pull request.

    • nextToken

      public final String nextToken()

      An enumeration token that, when provided in a request, returns the next batch of the results.

      Returns:
      An enumeration token that, when provided in a request, returns the next batch of the results.

    • maxResults

      public final Integer maxResults()

      A non-zero, non-negative integer used to limit the number of returned results. The default is 100 events, which is also the maximum number of events that can be returned in a result.

      Returns:
      A non-zero, non-negative integer used to limit the number of returned results. The default is 100 events, which is also the maximum number of events that can be returned in a result.

    • toBuilder

      public DescribePullRequestEventsRequest.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<DescribePullRequestEventsRequest.Builder,DescribePullRequestEventsRequest>
      Specified by:
      toBuilder in class CodeCommitRequest
      Returns:
      a builder for type T

    • builder

      public static DescribePullRequestEventsRequest.Builder builder()

    • serializableBuilderClass

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