Class MergeBranchesBySquashRequest

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.MergeBranchesBySquashRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<MergeBranchesBySquashRequest.Builder,MergeBranchesBySquashRequest>
@Generated("software.amazon.awssdk:codegen") public final class MergeBranchesBySquashRequest extends CodeCommitRequest implements ToCopyableBuilder<MergeBranchesBySquashRequest.Builder,MergeBranchesBySquashRequest>

  • Method Details

    • repositoryName

      public final String repositoryName()

      The name of the repository where you want to merge two branches.

      Returns:
      The name of the repository where you want to merge two branches.

    • sourceCommitSpecifier

      public final String sourceCommitSpecifier()

      The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).

      Returns:
      The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).

    • destinationCommitSpecifier

      public final String destinationCommitSpecifier()

      The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).

      Returns:
      The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name or a full commit ID).

    • targetBranch

      public final String targetBranch()

      The branch where the merge is applied.

      Returns:
      The branch where the merge is applied.

    • 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:

    • 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:

    • 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:

    • 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:

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

    • commitMessage

      public final String commitMessage()

      The commit message for the merge.

      Returns:
      The commit message 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 this is specified as 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 this is specified as 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 MergeBranchesBySquashRequest.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<MergeBranchesBySquashRequest.Builder,MergeBranchesBySquashRequest>
      Specified by:
      toBuilder in class CodeCommitRequest
      Returns:
      a builder for type T

    • builder

      public static MergeBranchesBySquashRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MergeBranchesBySquashRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.