libZSservicesZSamazonka-codecommitZSamazonka-codecommit
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodeCommit.MergePullRequestByThreeWay

Description

Attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the three-way merge strategy. If the merge is successful, it closes the pull request.

Synopsis

Creating a Request

data MergePullRequestByThreeWay Source #

See: newMergePullRequestByThreeWay smart constructor.

Constructors

MergePullRequestByThreeWay' 

Fields

  • email :: Maybe Text

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

  • authorName :: Maybe Text

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

  • conflictDetailLevel :: Maybe ConflictDetailLevelTypeEnum

    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.

  • commitMessage :: Maybe Text

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

  • conflictResolution :: Maybe ConflictResolution

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

  • conflictResolutionStrategy :: Maybe ConflictResolutionStrategyTypeEnum

    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.

  • keepEmptyFolders :: Maybe Bool

    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.

  • sourceCommitId :: Maybe Text

    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.

  • pullRequestId :: Text

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

  • repositoryName :: Text

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

Instances

Instances details
Eq MergePullRequestByThreeWay Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

Read MergePullRequestByThreeWay Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

Show MergePullRequestByThreeWay Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

Generic MergePullRequestByThreeWay Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

Associated Types

type Rep MergePullRequestByThreeWay :: Type -> Type #

NFData MergePullRequestByThreeWay Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

Hashable MergePullRequestByThreeWay Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

ToJSON MergePullRequestByThreeWay Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

AWSRequest MergePullRequestByThreeWay Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

ToHeaders MergePullRequestByThreeWay Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

ToPath MergePullRequestByThreeWay Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

ToQuery MergePullRequestByThreeWay Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

type Rep MergePullRequestByThreeWay Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

type Rep MergePullRequestByThreeWay = D1 ('MetaData "MergePullRequestByThreeWay" "Amazonka.CodeCommit.MergePullRequestByThreeWay" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "MergePullRequestByThreeWay'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "authorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "conflictDetailLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConflictDetailLevelTypeEnum)) :*: (S1 ('MetaSel ('Just "commitMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "conflictResolution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConflictResolution))))) :*: ((S1 ('MetaSel ('Just "conflictResolutionStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConflictResolutionStrategyTypeEnum)) :*: S1 ('MetaSel ('Just "keepEmptyFolders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "sourceCommitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pullRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse MergePullRequestByThreeWay Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

newMergePullRequestByThreeWay Source #

Create a value of MergePullRequestByThreeWay with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:email:MergePullRequestByThreeWay', mergePullRequestByThreeWay_email - The email address of the person merging the branches. This information is used in the commit information for the merge.

$sel:authorName:MergePullRequestByThreeWay', mergePullRequestByThreeWay_authorName - The name of the author who created the commit. This information is used as both the author and committer for the commit.

$sel:conflictDetailLevel:MergePullRequestByThreeWay', mergePullRequestByThreeWay_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.

$sel:commitMessage:MergePullRequestByThreeWay', mergePullRequestByThreeWay_commitMessage - The commit message to include in the commit information for the merge.

$sel:conflictResolution:MergePullRequestByThreeWay', mergePullRequestByThreeWay_conflictResolution - If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.

$sel:conflictResolutionStrategy:MergePullRequestByThreeWay', mergePullRequestByThreeWay_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.

$sel:keepEmptyFolders:MergePullRequestByThreeWay', mergePullRequestByThreeWay_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.

$sel:sourceCommitId:MergePullRequestByThreeWay', mergePullRequestByThreeWay_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.

$sel:pullRequestId:MergePullRequestByThreeWay', mergePullRequestByThreeWay_pullRequestId - The system-generated ID of the pull request. To get this ID, use ListPullRequests.

$sel:repositoryName:MergePullRequestByThreeWay', mergePullRequestByThreeWay_repositoryName - The name of the repository where the pull request was created.

Request Lenses

mergePullRequestByThreeWay_email :: Lens' MergePullRequestByThreeWay (Maybe Text) Source #

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

mergePullRequestByThreeWay_authorName :: Lens' MergePullRequestByThreeWay (Maybe Text) Source #

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

mergePullRequestByThreeWay_conflictDetailLevel :: Lens' MergePullRequestByThreeWay (Maybe ConflictDetailLevelTypeEnum) Source #

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.

mergePullRequestByThreeWay_commitMessage :: Lens' MergePullRequestByThreeWay (Maybe Text) Source #

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

mergePullRequestByThreeWay_conflictResolution :: Lens' MergePullRequestByThreeWay (Maybe ConflictResolution) Source #

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

mergePullRequestByThreeWay_conflictResolutionStrategy :: Lens' MergePullRequestByThreeWay (Maybe ConflictResolutionStrategyTypeEnum) Source #

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.

mergePullRequestByThreeWay_keepEmptyFolders :: Lens' MergePullRequestByThreeWay (Maybe Bool) Source #

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.

mergePullRequestByThreeWay_sourceCommitId :: Lens' MergePullRequestByThreeWay (Maybe Text) Source #

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.

mergePullRequestByThreeWay_pullRequestId :: Lens' MergePullRequestByThreeWay Text Source #

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

mergePullRequestByThreeWay_repositoryName :: Lens' MergePullRequestByThreeWay Text Source #

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

Destructuring the Response

data MergePullRequestByThreeWayResponse Source #

Constructors

MergePullRequestByThreeWayResponse' 

Fields

Instances

Instances details
Eq MergePullRequestByThreeWayResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

Read MergePullRequestByThreeWayResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

Show MergePullRequestByThreeWayResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

Generic MergePullRequestByThreeWayResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

Associated Types

type Rep MergePullRequestByThreeWayResponse :: Type -> Type #

NFData MergePullRequestByThreeWayResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

type Rep MergePullRequestByThreeWayResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.MergePullRequestByThreeWay

type Rep MergePullRequestByThreeWayResponse = D1 ('MetaData "MergePullRequestByThreeWayResponse" "Amazonka.CodeCommit.MergePullRequestByThreeWay" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "MergePullRequestByThreeWayResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pullRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PullRequest)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newMergePullRequestByThreeWayResponse Source #

Create a value of MergePullRequestByThreeWayResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pullRequest:MergePullRequestByThreeWayResponse', mergePullRequestByThreeWayResponse_pullRequest - Undocumented member.

$sel:httpStatus:MergePullRequestByThreeWayResponse', mergePullRequestByThreeWayResponse_httpStatus - The response's http status code.

Response Lenses