CommentsForPullRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.codecommit.model.CommentsForPullRequest

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<CommentsForPullRequest.Builder,CommentsForPullRequest>

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

Returns information about comments on a pull request.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CommentsForPullRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CommentsForPullRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`afterBlobId()` The full blob ID of the file on which you want to comment on the source commit.
`String`	`afterCommitId()` The full commit ID of the commit that was the tip of the source branch at the time the comment was made.
`String`	`beforeBlobId()` The full blob ID of the file on which you want to comment on the destination commit.
`String`	`beforeCommitId()` The full commit ID of the commit that was the tip of the destination branch when the pull request was created.
`static CommentsForPullRequest.Builder`	`builder()`
`List<Comment>`	`comments()` An array of comment objects.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasComments()` For responses, this returns true if the service returned a value for the Comments property.
`int`	`hashCode()`
`Location`	`location()` Location information about the comment on the pull request, including the file name, line number, and whether the version of the file where the comment was made is BEFORE (destination branch) or AFTER (source branch).
`String`	`pullRequestId()` The system-generated ID of the pull request.
`String`	`repositoryName()` The name of the repository that contains the pull request.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CommentsForPullRequest.Builder>`	`serializableBuilderClass()`
`CommentsForPullRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - pullRequestId
```
public final String pullRequestId()
```
    The system-generated ID of the pull request.
    
    Returns:
    
    The system-generated ID of the pull request.
  - repositoryName
```
public final String repositoryName()
```
    The name of the repository that contains the pull request.
    
    Returns:
    
    The name of the repository that contains the pull request.
  - beforeCommitId
```
public final String beforeCommitId()
```
    The full commit ID of the commit that was the tip of the destination branch when the pull request was created. This commit is superceded by the after commit in the source branch when and if you merge the source branch into the destination branch.
    
    Returns:
    
    The full commit ID of the commit that was the tip of the destination branch when the pull request was created. This commit is superceded by the after commit in the source branch when and if you merge the source branch into the destination branch.
  - afterCommitId
```
public final String afterCommitId()
```
    The full commit ID of the commit that was the tip of the source branch at the time the comment was made.
    
    Returns:
    
    The full commit ID of the commit that was the tip of the source branch at the time the comment was made.
  - beforeBlobId
```
public final String beforeBlobId()
```
    The full blob ID of the file on which you want to comment on the destination commit.
    
    Returns:
    
    The full blob ID of the file on which you want to comment on the destination commit.
  - afterBlobId
```
public final String afterBlobId()
```
    The full blob ID of the file on which you want to comment on the source commit.
    
    Returns:
    
    The full blob ID of the file on which you want to comment on the source commit.
  - location
```
public final Location location()
```
    Location information about the comment on the pull request, including the file name, line number, and whether the version of the file where the comment was made is BEFORE (destination branch) or AFTER (source branch).
    
    Returns:
    
    Location information about the comment on the pull request, including the file name, line number, and whether the version of the file where the comment was made is BEFORE (destination branch) or AFTER (source branch).
  - hasComments
```
public final boolean hasComments()
```
    For responses, this returns true if the service returned a value for the Comments 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.
  - comments
```
public final List<Comment> comments()
```
    An array of comment objects. Each comment object contains information about a comment on 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 hasComments() method.
    
    Returns:
    
    An array of comment objects. Each comment object contains information about a comment on the pull request.
  - toBuilder
```
public CommentsForPullRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CommentsForPullRequest.Builder,CommentsForPullRequest>
  - builder
```
public static CommentsForPullRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CommentsForPullRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class CommentsForPullRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

pullRequestId

repositoryName

beforeCommitId

afterCommitId

beforeBlobId

afterBlobId

location

hasComments

comments

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields