Amazonka.CodeCommit.MergePullRequestBySquash

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 squash merge strategy. If the merge is successful, it closes the pull request.

Creating a Request

data MergePullRequestBySquash

See: newMergePullRequestBySquash smart constructor.

Constructors

MergePullRequestBySquash'

Fields

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

• commitMessage :: Maybe Text

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

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

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

• email :: Maybe Text

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

• 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

ToJSON MergePullRequestBySquash

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Methods

toJSON :: MergePullRequestBySquash -> Value

toEncoding :: MergePullRequestBySquash -> Encoding

toJSONList :: [MergePullRequestBySquash] -> Value

toEncodingList :: [MergePullRequestBySquash] -> Encoding

ToHeaders MergePullRequestBySquash

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Methods

toHeaders :: MergePullRequestBySquash -> [Header]

ToPath MergePullRequestBySquash

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Methods

toPath :: MergePullRequestBySquash -> ByteString

ToQuery MergePullRequestBySquash

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Methods

toQuery :: MergePullRequestBySquash -> QueryString

AWSRequest MergePullRequestBySquash

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Associated Types

type AWSResponse MergePullRequestBySquash

Methods

request :: (Service -> Service) -> MergePullRequestBySquash -> Request MergePullRequestBySquash

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy MergePullRequestBySquash -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse MergePullRequestBySquash)))

Generic MergePullRequestBySquash

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Associated Types

type Rep MergePullRequestBySquash :: Type -> Type

Methods

from :: MergePullRequestBySquash -> Rep MergePullRequestBySquash x

to :: Rep MergePullRequestBySquash x -> MergePullRequestBySquash

Read MergePullRequestBySquash

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Methods

readsPrec :: Int -> ReadS MergePullRequestBySquash

readList :: ReadS [MergePullRequestBySquash]

readPrec :: ReadPrec MergePullRequestBySquash

readListPrec :: ReadPrec [MergePullRequestBySquash]

Show MergePullRequestBySquash

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Methods

showsPrec :: Int -> MergePullRequestBySquash -> ShowS

show :: MergePullRequestBySquash -> String

showList :: [MergePullRequestBySquash] -> ShowS

NFData MergePullRequestBySquash

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Methods

rnf :: MergePullRequestBySquash -> ()

Eq MergePullRequestBySquash

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Methods

(==) :: MergePullRequestBySquash -> MergePullRequestBySquash -> Bool

(/=) :: MergePullRequestBySquash -> MergePullRequestBySquash -> Bool

Hashable MergePullRequestBySquash

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Methods

hashWithSalt :: Int -> MergePullRequestBySquash -> Int

hash :: MergePullRequestBySquash -> Int

type AWSResponse MergePullRequestBySquash

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

type AWSResponse MergePullRequestBySquash = MergePullRequestBySquashResponse

type Rep MergePullRequestBySquash

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

type Rep MergePullRequestBySquash = D1 ('MetaData "MergePullRequestBySquash" "Amazonka.CodeCommit.MergePullRequestBySquash" "amazonka-codecommit-2.0-974g5LOhuTPG9HgUSx02zG" 'False) (C1 ('MetaCons "MergePullRequestBySquash'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "commitMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "conflictDetailLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConflictDetailLevelTypeEnum)) :*: (S1 ('MetaSel ('Just "conflictResolution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConflictResolution)) :*: S1 ('MetaSel ('Just "conflictResolutionStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConflictResolutionStrategyTypeEnum))))) :*: ((S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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))))))

newMergePullRequestBySquash

Arguments

:: Text

MergePullRequestBySquash

-> Text

MergePullRequestBySquash

-> MergePullRequestBySquash

Create a value of MergePullRequestBySquash 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:authorName:MergePullRequestBySquash', mergePullRequestBySquash_authorName - The name of the author who created the commit. This information is used as both the author and committer for the commit.

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

$sel:conflictDetailLevel:MergePullRequestBySquash', mergePullRequestBySquash_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:conflictResolution:MergePullRequestBySquash', mergePullRequestBySquash_conflictResolution - If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a merge.

$sel:conflictResolutionStrategy:MergePullRequestBySquash', mergePullRequestBySquash_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.

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

$sel:keepEmptyFolders:MergePullRequestBySquash', mergePullRequestBySquash_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.

MergePullRequestBySquash, mergePullRequestBySquash_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.

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

MergePullRequestBySquash, mergePullRequestBySquash_repositoryName - The name of the repository where the pull request was created.

Request Lenses

mergePullRequestBySquash_authorName :: Lens' MergePullRequestBySquash (Maybe Text)

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

mergePullRequestBySquash_commitMessage :: Lens' MergePullRequestBySquash (Maybe Text)

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

mergePullRequestBySquash_conflictDetailLevel :: Lens' MergePullRequestBySquash (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.

mergePullRequestBySquash_conflictResolution :: Lens' MergePullRequestBySquash (Maybe ConflictResolution)

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

mergePullRequestBySquash_conflictResolutionStrategy :: Lens' MergePullRequestBySquash (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.

mergePullRequestBySquash_email :: Lens' MergePullRequestBySquash (Maybe Text)

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

mergePullRequestBySquash_keepEmptyFolders :: Lens' MergePullRequestBySquash (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.

mergePullRequestBySquash_sourceCommitId :: Lens' MergePullRequestBySquash (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.

mergePullRequestBySquash_pullRequestId :: Lens' MergePullRequestBySquash Text

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

mergePullRequestBySquash_repositoryName :: Lens' MergePullRequestBySquash Text

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

Destructuring the Response

data MergePullRequestBySquashResponse

See: newMergePullRequestBySquashResponse smart constructor.

Constructors

MergePullRequestBySquashResponse'

Fields

• pullRequest :: Maybe PullRequest
• httpStatus :: Int

  The response's http status code.

Instances

Generic MergePullRequestBySquashResponse

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Associated Types

type Rep MergePullRequestBySquashResponse :: Type -> Type

Methods

from :: MergePullRequestBySquashResponse -> Rep MergePullRequestBySquashResponse x

to :: Rep MergePullRequestBySquashResponse x -> MergePullRequestBySquashResponse

Read MergePullRequestBySquashResponse

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Methods

readsPrec :: Int -> ReadS MergePullRequestBySquashResponse

readList :: ReadS [MergePullRequestBySquashResponse]

readPrec :: ReadPrec MergePullRequestBySquashResponse

readListPrec :: ReadPrec [MergePullRequestBySquashResponse]

Show MergePullRequestBySquashResponse

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Methods

showsPrec :: Int -> MergePullRequestBySquashResponse -> ShowS

show :: MergePullRequestBySquashResponse -> String

showList :: [MergePullRequestBySquashResponse] -> ShowS

NFData MergePullRequestBySquashResponse

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Methods

rnf :: MergePullRequestBySquashResponse -> ()

Eq MergePullRequestBySquashResponse

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

Methods

(==) :: MergePullRequestBySquashResponse -> MergePullRequestBySquashResponse -> Bool

(/=) :: MergePullRequestBySquashResponse -> MergePullRequestBySquashResponse -> Bool

type Rep MergePullRequestBySquashResponse

Defined in Amazonka.CodeCommit.MergePullRequestBySquash

type Rep MergePullRequestBySquashResponse = D1 ('MetaData "MergePullRequestBySquashResponse" "Amazonka.CodeCommit.MergePullRequestBySquash" "amazonka-codecommit-2.0-974g5LOhuTPG9HgUSx02zG" 'False) (C1 ('MetaCons "MergePullRequestBySquashResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pullRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PullRequest)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newMergePullRequestBySquashResponse

Arguments

:: Int

$sel:httpStatus:MergePullRequestBySquashResponse'

-> MergePullRequestBySquashResponse

Create a value of MergePullRequestBySquashResponse 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:MergePullRequestBySquashResponse', mergePullRequestBySquashResponse_pullRequest - Undocumented member.

$sel:httpStatus:MergePullRequestBySquashResponse', mergePullRequestBySquashResponse_httpStatus - The response's http status code.

Response Lenses

mergePullRequestBySquashResponse_pullRequest :: Lens' MergePullRequestBySquashResponse (Maybe PullRequest)

Undocumented member.

mergePullRequestBySquashResponse_httpStatus :: Lens' MergePullRequestBySquashResponse Int

The response's http status code.