Package 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("software.amazon.awssdk:codegen")
public final class CreatePullRequestRequest
extends CodeCommitRequest
implements ToCopyableBuilder<CreatePullRequestRequest.Builder,CreatePullRequestRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePullRequestRequest.Builder

Method Summary

Modifier and Type	Method	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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTargets()	For responses, this returns true if the service returned a value for the Targets property.
Map<String,SdkField<?>>	sdkFieldNameToField()
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()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

title

public final String title()

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

Returns:

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

description

public final String description()

A description of the pull request.

Returns:

A description of the pull request.

hasTargets

public final boolean hasTargets()

For responses, this returns true if the service returned a value for the Targets 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.

targets

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

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 hasTargets() method.

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

The Amazon Web ServicesSDKs prepopulate client request tokens. If you are using an Amazon Web ServicesSDK, an idempotency token is created 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 returns information about the initial request that used that token.

The Amazon Web ServicesSDKs prepopulate client request tokens. If you are using an Amazon Web ServicesSDK, an idempotency token is created for you.

toBuilder

public CreatePullRequestRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePullRequestRequest.Builder,CreatePullRequestRequest>

Specified by:

toBuilder in class CodeCommitRequest

builder

public static CreatePullRequestRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo