software.amazon.awssdk.services.codecommit.model

Class CreatePullRequestRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePullRequestRequest.Builder,CreatePullRequestRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreatePullRequestRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreatePullRequestRequest.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.
String	description() A description of the pull request.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePullRequestRequest.Builder>	serializableBuilderClass()
List<Target>	targets() The targets for the pull request, including the source of the code to be reviewed (the source branch), and the destination where the creator of the pull request intends the code to be merged after the pull request is closed (the destination branch).
String	title() The title of the pull request.
CreatePullRequestRequest.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 software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

title

public String title()

The title of the pull request. This title will be used to identify the pull request to other users in the repository.

Returns:

The title of the pull request. This title will be used to identify the pull request to other users in the repository.

description

public String description()

A description of the pull request.

Returns:

A description of the pull request.

targets

public List<Target> targets()

The targets for the pull request, including the source of the code to be reviewed (the source branch), and the destination where the creator of the pull request intends the code to be merged after the pull request is closed (the destination branch).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The targets for the pull request, including the source of the code to be reviewed (the source branch), and the destination where the creator of the pull request intends the code to be merged after the pull request is closed (the destination branch).

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.

The AWS SDKs prepopulate client request tokens. If using an AWS SDK, you do not have to generate an idempotency token, as this will be done for you.

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.

The AWS SDKs prepopulate client request tokens. If using an AWS SDK, you do not have to generate an idempotency token, as this will be done for you.

toBuilder

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

Specified by:

toBuilder in class CodeCommitRequest

Returns:

a builder for type T

builder

public static CreatePullRequestRequest.Builder builder()

serializableBuilderClass

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

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