Class CommentsForPullRequest
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CommentsForPullRequest.Builder,
CommentsForPullRequest>
Returns information about comments on a pull request.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The full blob ID of the file on which you want to comment on the source commit.final String
The full commit ID of the commit that was the tip of the source branch at the time the comment was made.final String
The full blob ID of the file on which you want to comment on the destination commit.final String
The full commit ID of the commit that was the tip of the destination branch when the pull request was created.builder()
comments()
An array of comment objects.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Comments property.final int
hashCode()
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).final String
The system-generated ID of the pull request.final String
The name of the repository that contains the pull request.static Class
<? extends CommentsForPullRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
pullRequestId
The system-generated ID of the pull request.
- Returns:
- The system-generated ID of the pull request.
-
repositoryName
The name of the repository that contains the pull request.
- Returns:
- The name of the repository that contains the pull request.
-
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
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
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
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<CommentsForPullRequest.Builder,
CommentsForPullRequest> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-