software.amazon.awssdk.services.codecommit.model

Class PullRequest

java.lang.Object

software.amazon.awssdk.services.codecommit.model.PullRequest

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<PullRequest.Builder,PullRequest>

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

Returns information about a pull request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PullRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	authorArn() The Amazon Resource Name (ARN) of the user who created the pull request.
static PullRequest.Builder	builder()
String	clientRequestToken() A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter.
Instant	creationDate() The date and time the pull request was originally created, in timestamp format.
String	description() The user-defined description of the pull request.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastActivityDate() The day and time of the last user or system activity on the pull request, in timestamp format.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	pullRequestId() The system-generated ID of the pull request.
PullRequestStatusEnum	pullRequestStatus() The status of the pull request.
String	pullRequestStatusAsString() 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.
static Class<? extends PullRequest.Builder>	serializableBuilderClass()
String	title() The user-defined title of the pull request.
PullRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

pullRequestId

public String pullRequestId()

The system-generated ID of the pull request.

Returns:

The system-generated ID of the pull request.

title

public String title()

The user-defined title of the pull request. This title is displayed in the list of pull requests to other users of the repository.

Returns:

The user-defined title of the pull request. This title is displayed in the list of pull requests to other users of the repository.

description

public 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 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 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 PullRequestStatusEnum pullRequestStatus()

The status of the pull request. Pull request status can only change from OPEN to CLOSED .

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

Returns:

The status of the pull request. Pull request status can only change from OPEN to CLOSED.

See Also:

PullRequestStatusEnum

pullRequestStatusAsString

public String pullRequestStatusAsString()

The status of the pull request. Pull request status can only change from OPEN to CLOSED .

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

Returns:

The status of the pull request. Pull request status can only change from OPEN to CLOSED.

See Also:

PullRequestStatusEnum

authorArn

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

pullRequestTargets

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

Returns:

The targets of the pull request, including the source branch and destination branch for the pull request.

clientRequestToken

public 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 will return 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 will return information about the initial request that used that token.

toBuilder

public PullRequest.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<PullRequest.Builder,PullRequest>

Returns:

a builder for type T

builder

public static PullRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PullRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.