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

Description

Merges two branches using the squash merge strategy.

Synopsis

Creating a Request

data MergeBranchesBySquash Source #

See: newMergeBranchesBySquash smart constructor.

Constructors

MergeBranchesBySquash' 

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.

  • targetBranch :: Maybe Text

    The branch where the merge is applied.

  • 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 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 this is specified as true, a .gitkeep file is created for empty folders. The default is false.

  • repositoryName :: Text

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

  • sourceCommitSpecifier :: Text

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

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

Instances

Instances details
Eq MergeBranchesBySquash Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

Read MergeBranchesBySquash Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

Show MergeBranchesBySquash Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

Generic MergeBranchesBySquash Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

Associated Types

type Rep MergeBranchesBySquash :: Type -> Type #

NFData MergeBranchesBySquash Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

Methods

rnf :: MergeBranchesBySquash -> () #

Hashable MergeBranchesBySquash Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

ToJSON MergeBranchesBySquash Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

AWSRequest MergeBranchesBySquash Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

Associated Types

type AWSResponse MergeBranchesBySquash #

ToHeaders MergeBranchesBySquash Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

ToPath MergeBranchesBySquash Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

ToQuery MergeBranchesBySquash Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

type Rep MergeBranchesBySquash Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

type Rep MergeBranchesBySquash = D1 ('MetaData "MergeBranchesBySquash" "Amazonka.CodeCommit.MergeBranchesBySquash" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "MergeBranchesBySquash'" '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 "targetBranch") '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 "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sourceCommitSpecifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "destinationCommitSpecifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse MergeBranchesBySquash Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

newMergeBranchesBySquash Source #

Create a value of MergeBranchesBySquash 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:MergeBranchesBySquash', mergeBranchesBySquash_email - The email address of the person merging the branches. This information is used in the commit information for the merge.

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

$sel:targetBranch:MergeBranchesBySquash', mergeBranchesBySquash_targetBranch - The branch where the merge is applied.

$sel:conflictDetailLevel:MergeBranchesBySquash', mergeBranchesBySquash_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:MergeBranchesBySquash', mergeBranchesBySquash_commitMessage - The commit message for the merge.

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

$sel:conflictResolutionStrategy:MergeBranchesBySquash', mergeBranchesBySquash_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:MergeBranchesBySquash', mergeBranchesBySquash_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.

$sel:repositoryName:MergeBranchesBySquash', mergeBranchesBySquash_repositoryName - The name of the repository where you want to merge two branches.

$sel:sourceCommitSpecifier:MergeBranchesBySquash', mergeBranchesBySquash_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).

$sel:destinationCommitSpecifier:MergeBranchesBySquash', mergeBranchesBySquash_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).

Request Lenses

mergeBranchesBySquash_email :: Lens' MergeBranchesBySquash (Maybe Text) Source #

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

mergeBranchesBySquash_authorName :: Lens' MergeBranchesBySquash (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.

mergeBranchesBySquash_conflictDetailLevel :: Lens' MergeBranchesBySquash (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.

mergeBranchesBySquash_conflictResolution :: Lens' MergeBranchesBySquash (Maybe ConflictResolution) Source #

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

mergeBranchesBySquash_conflictResolutionStrategy :: Lens' MergeBranchesBySquash (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.

mergeBranchesBySquash_keepEmptyFolders :: Lens' MergeBranchesBySquash (Maybe Bool) Source #

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.

mergeBranchesBySquash_repositoryName :: Lens' MergeBranchesBySquash Text Source #

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

mergeBranchesBySquash_sourceCommitSpecifier :: Lens' MergeBranchesBySquash Text Source #

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

mergeBranchesBySquash_destinationCommitSpecifier :: Lens' MergeBranchesBySquash Text Source #

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

Destructuring the Response

data MergeBranchesBySquashResponse Source #

See: newMergeBranchesBySquashResponse smart constructor.

Constructors

MergeBranchesBySquashResponse' 

Fields

Instances

Instances details
Eq MergeBranchesBySquashResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

Read MergeBranchesBySquashResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

Show MergeBranchesBySquashResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

Generic MergeBranchesBySquashResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

Associated Types

type Rep MergeBranchesBySquashResponse :: Type -> Type #

NFData MergeBranchesBySquashResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

type Rep MergeBranchesBySquashResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.MergeBranchesBySquash

type Rep MergeBranchesBySquashResponse = D1 ('MetaData "MergeBranchesBySquashResponse" "Amazonka.CodeCommit.MergeBranchesBySquash" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "MergeBranchesBySquashResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "commitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "treeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newMergeBranchesBySquashResponse Source #

Create a value of MergeBranchesBySquashResponse 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:commitId:MergeBranchesBySquashResponse', mergeBranchesBySquashResponse_commitId - The commit ID of the merge in the destination or target branch.

$sel:treeId:MergeBranchesBySquashResponse', mergeBranchesBySquashResponse_treeId - The tree ID of the merge in the destination or target branch.

$sel:httpStatus:MergeBranchesBySquashResponse', mergeBranchesBySquashResponse_httpStatus - The response's http status code.

Response Lenses

mergeBranchesBySquashResponse_commitId :: Lens' MergeBranchesBySquashResponse (Maybe Text) Source #

The commit ID of the merge in the destination or target branch.

mergeBranchesBySquashResponse_treeId :: Lens' MergeBranchesBySquashResponse (Maybe Text) Source #

The tree ID of the merge in the destination or target branch.