software.amazon.awssdk.services.codecommit.model

Class MergePullRequestBySquashRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<MergePullRequestBySquashRequest.Builder,MergePullRequestBySquashRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MergePullRequestBySquashRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	authorName() The name of the author who created the commit.
static MergePullRequestBySquashRequest.Builder	builder()
String	commitMessage() The commit message to include in the commit information for the merge.
ConflictDetailLevelTypeEnum	conflictDetailLevel() The level of conflict detail to use.
String	conflictDetailLevelAsString() The level of conflict detail to use.
ConflictResolution	conflictResolution() If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.
ConflictResolutionStrategyTypeEnum	conflictResolutionStrategy() Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file.
String	conflictResolutionStrategyAsString() Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file.
String	email() The email address of the person merging the branches.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	keepEmptyFolders() If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty.
String	pullRequestId() The system-generated ID of the pull request.
String	repositoryName() The name of the repository where the pull request was created.
List<SdkField<?>>	sdkFields()
static Class<? extends MergePullRequestBySquashRequest.Builder>	serializableBuilderClass()
String	sourceCommitId() The full commit ID of the original or updated commit in the pull request source branch.
MergePullRequestBySquashRequest.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

pullRequestId

public final String pullRequestId()

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

Returns:

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

repositoryName

public final String repositoryName()

The name of the repository where the pull request was created.

Returns:

The name of the repository where the pull request was created.

sourceCommitId

public final String sourceCommitId()

The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.

Returns:

The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.

conflictDetailLevel

public final ConflictDetailLevelTypeEnum conflictDetailLevel()

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.

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

Returns:

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.

See Also:

ConflictDetailLevelTypeEnum

conflictDetailLevelAsString

public final String conflictDetailLevelAsString()

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.

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

Returns:

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is considered not mergeable if the same file in both branches has differences on the same line.

See Also:

ConflictDetailLevelTypeEnum

conflictResolutionStrategy

public final ConflictResolutionStrategyTypeEnum conflictResolutionStrategy()

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.

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

Returns:

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.

See Also:

ConflictResolutionStrategyTypeEnum

conflictResolutionStrategyAsString

public final String conflictResolutionStrategyAsString()

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.

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

Returns:

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation is successful.

See Also:

ConflictResolutionStrategyTypeEnum

commitMessage

public final String commitMessage()

The commit message to include in the commit information for the merge.

Returns:

The commit message to include in the commit information for the merge.

authorName

public final String authorName()

The name of the author who created the commit. This information is used as both the author and committer for the commit.

Returns:

The name of the author who created the commit. This information is used as both the author and committer for the commit.

email

public final String email()

The email address of the person merging the branches. This information is used in the commit information for the merge.

Returns:

The email address of the person merging the branches. This information is used in the commit information for the merge.

keepEmptyFolders

public final Boolean keepEmptyFolders()

If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a .gitkeep file is created for empty folders. The default is false.

Returns:

If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a .gitkeep file is created for empty folders. The default is false.

conflictResolution

public final ConflictResolution conflictResolution()

If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.

Returns:

If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.

toBuilder

public MergePullRequestBySquashRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MergePullRequestBySquashRequest.Builder,MergePullRequestBySquashRequest>

Specified by:

toBuilder in class CodeCommitRequest

builder

public static MergePullRequestBySquashRequest.Builder builder()

serializableBuilderClass

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