Class PostCommentForPullRequestRequest

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

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

    • repositoryName

      public final String repositoryName()

      The name of the repository where you want to post a comment on a pull request.

      Returns:
      The name of the repository where you want to post a comment on a pull request.

    • beforeCommitId

      public final String beforeCommitId()

      The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.

      Returns:
      The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.

    • afterCommitId

      public final String afterCommitId()

      The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.

      Returns:
      The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.

    • location

      public final Location location()

      The location of the change where you want to post your comment. If no location is provided, the comment is posted as a general comment on the pull request difference between the before commit ID and the after commit ID.

      Returns:
      The location of the change where you want to post your comment. If no location is provided, the comment is posted as a general comment on the pull request difference between the before commit ID and the after commit ID.

    • content

      public final String content()

      The content of your comment on the change.

      Returns:
      The content of your comment on the change.

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

    • toBuilder

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

    • builder

      public static PostCommentForPullRequestRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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