Class PullRequest
- 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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePullRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<ApprovalRule>approvalRules()The approval rules applied to the pull request.StringauthorArn()The Amazon Resource Name (ARN) of the user who created the pull request.static PullRequest.Builderbuilder()StringclientRequestToken()A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter.InstantcreationDate()The date and time the pull request was originally created, in timestamp format.Stringdescription()The user-defined description of the pull request.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasApprovalRules()For responses, this returns true if the service returned a value for the ApprovalRules property.inthashCode()booleanhasPullRequestTargets()For responses, this returns true if the service returned a value for the PullRequestTargets property.InstantlastActivityDate()The day and time of the last user or system activity on the pull request, in timestamp format.StringpullRequestId()The system-generated ID of the pull request.PullRequestStatusEnumpullRequestStatus()The status of the pull request.StringpullRequestStatusAsString()The status of the pull request.List<PullRequestTarget>pullRequestTargets()The targets of the pull request, including the source branch and destination branch for the pull request.StringrevisionId()The system-generated revision ID for the pull request.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends PullRequest.Builder>serializableBuilderClass()Stringtitle()The user-defined title of the pull request.PullRequest.BuildertoBuilder()StringtoString()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.
-
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
OPENtoCLOSED.If the service returns an enum value that is not available in the current SDK version,
pullRequestStatuswill returnPullRequestStatusEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompullRequestStatusAsString().- Returns:
- The status of the pull request. Pull request status can only change from
OPENtoCLOSED. - See Also:
PullRequestStatusEnum
-
pullRequestStatusAsString
public final String pullRequestStatusAsString()
The status of the pull request. Pull request status can only change from
OPENtoCLOSED.If the service returns an enum value that is not available in the current SDK version,
pullRequestStatuswill returnPullRequestStatusEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompullRequestStatusAsString().- Returns:
- The status of the pull request. Pull request status can only change from
OPENtoCLOSED. - See Also:
PullRequestStatusEnum
-
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 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.
-
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 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.
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PullRequest.Builder,PullRequest>
-
builder
public static PullRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends PullRequest.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-