amazonka-codecommit-2.0: Amazon CodeCommit SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeCommit.GetMergeConflicts

Description

Returns information about merge conflicts between the before and after commit IDs for a pull request in a repository.

Synopsis

Creating a Request

data GetMergeConflicts Source #

See: newGetMergeConflicts smart constructor.

Constructors

GetMergeConflicts' 

Fields

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

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

  • maxConflictFiles :: Maybe Int

    The maximum number of files to include in the output.

  • nextToken :: Maybe Text

    An enumeration token that, when provided in a request, returns the next batch of the results.

  • repositoryName :: Text

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

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

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

  • mergeOption :: MergeOptionTypeEnum

    The merge option or strategy you want to use to merge the code.

Instances

Instances details
ToJSON GetMergeConflicts Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

ToHeaders GetMergeConflicts Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

ToPath GetMergeConflicts Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

ToQuery GetMergeConflicts Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

AWSRequest GetMergeConflicts Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

Associated Types

type AWSResponse GetMergeConflicts #

Generic GetMergeConflicts Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

Associated Types

type Rep GetMergeConflicts :: Type -> Type #

Read GetMergeConflicts Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

Show GetMergeConflicts Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

NFData GetMergeConflicts Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

Methods

rnf :: GetMergeConflicts -> () #

Eq GetMergeConflicts Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

Hashable GetMergeConflicts Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

type AWSResponse GetMergeConflicts Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

type Rep GetMergeConflicts Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

type Rep GetMergeConflicts = D1 ('MetaData "GetMergeConflicts" "Amazonka.CodeCommit.GetMergeConflicts" "amazonka-codecommit-2.0-974g5LOhuTPG9HgUSx02zG" 'False) (C1 ('MetaCons "GetMergeConflicts'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "conflictDetailLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConflictDetailLevelTypeEnum)) :*: S1 ('MetaSel ('Just "conflictResolutionStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConflictResolutionStrategyTypeEnum))) :*: (S1 ('MetaSel ('Just "maxConflictFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "destinationCommitSpecifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "sourceCommitSpecifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "mergeOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MergeOptionTypeEnum)))))

newGetMergeConflicts Source #

Create a value of GetMergeConflicts 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:conflictDetailLevel:GetMergeConflicts', getMergeConflicts_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:conflictResolutionStrategy:GetMergeConflicts', getMergeConflicts_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:maxConflictFiles:GetMergeConflicts', getMergeConflicts_maxConflictFiles - The maximum number of files to include in the output.

GetMergeConflicts, getMergeConflicts_nextToken - An enumeration token that, when provided in a request, returns the next batch of the results.

GetMergeConflicts, getMergeConflicts_repositoryName - The name of the repository where the pull request was created.

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

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

GetMergeConflicts, getMergeConflicts_mergeOption - The merge option or strategy you want to use to merge the code.

Request Lenses

getMergeConflicts_conflictDetailLevel :: Lens' GetMergeConflicts (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.

getMergeConflicts_conflictResolutionStrategy :: Lens' GetMergeConflicts (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.

getMergeConflicts_maxConflictFiles :: Lens' GetMergeConflicts (Maybe Int) Source #

The maximum number of files to include in the output.

getMergeConflicts_nextToken :: Lens' GetMergeConflicts (Maybe Text) Source #

An enumeration token that, when provided in a request, returns the next batch of the results.

getMergeConflicts_repositoryName :: Lens' GetMergeConflicts Text Source #

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

getMergeConflicts_destinationCommitSpecifier :: Lens' GetMergeConflicts 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).

getMergeConflicts_sourceCommitSpecifier :: Lens' GetMergeConflicts 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).

getMergeConflicts_mergeOption :: Lens' GetMergeConflicts MergeOptionTypeEnum Source #

The merge option or strategy you want to use to merge the code.

Destructuring the Response

data GetMergeConflictsResponse Source #

See: newGetMergeConflictsResponse smart constructor.

Constructors

GetMergeConflictsResponse' 

Fields

  • baseCommitId :: Maybe Text

    The commit ID of the merge base.

  • nextToken :: Maybe Text

    An enumeration token that can be used in a request to return the next batch of the results.

  • httpStatus :: Int

    The response's http status code.

  • mergeable :: Bool

    A Boolean value that indicates whether the code is mergeable by the specified merge option.

  • destinationCommitId :: Text

    The commit ID of the destination commit specifier that was used in the merge evaluation.

  • sourceCommitId :: Text

    The commit ID of the source commit specifier that was used in the merge evaluation.

  • conflictMetadataList :: [ConflictMetadata]

    A list of metadata for any conflicting files. If the specified merge strategy is FAST_FORWARD_MERGE, this list is always empty.

Instances

Instances details
Generic GetMergeConflictsResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

Associated Types

type Rep GetMergeConflictsResponse :: Type -> Type #

Read GetMergeConflictsResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

Show GetMergeConflictsResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

NFData GetMergeConflictsResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

Eq GetMergeConflictsResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

type Rep GetMergeConflictsResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetMergeConflicts

type Rep GetMergeConflictsResponse = D1 ('MetaData "GetMergeConflictsResponse" "Amazonka.CodeCommit.GetMergeConflicts" "amazonka-codecommit-2.0-974g5LOhuTPG9HgUSx02zG" 'False) (C1 ('MetaCons "GetMergeConflictsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "baseCommitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :*: ((S1 ('MetaSel ('Just "mergeable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "destinationCommitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "sourceCommitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "conflictMetadataList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ConflictMetadata])))))

newGetMergeConflictsResponse Source #

Create a value of GetMergeConflictsResponse 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:baseCommitId:GetMergeConflictsResponse', getMergeConflictsResponse_baseCommitId - The commit ID of the merge base.

GetMergeConflicts, getMergeConflictsResponse_nextToken - An enumeration token that can be used in a request to return the next batch of the results.

$sel:httpStatus:GetMergeConflictsResponse', getMergeConflictsResponse_httpStatus - The response's http status code.

$sel:mergeable:GetMergeConflictsResponse', getMergeConflictsResponse_mergeable - A Boolean value that indicates whether the code is mergeable by the specified merge option.

GetMergeConflictsResponse, getMergeConflictsResponse_destinationCommitId - The commit ID of the destination commit specifier that was used in the merge evaluation.

GetMergeConflictsResponse, getMergeConflictsResponse_sourceCommitId - The commit ID of the source commit specifier that was used in the merge evaluation.

$sel:conflictMetadataList:GetMergeConflictsResponse', getMergeConflictsResponse_conflictMetadataList - A list of metadata for any conflicting files. If the specified merge strategy is FAST_FORWARD_MERGE, this list is always empty.

Response Lenses

getMergeConflictsResponse_nextToken :: Lens' GetMergeConflictsResponse (Maybe Text) Source #

An enumeration token that can be used in a request to return the next batch of the results.

getMergeConflictsResponse_mergeable :: Lens' GetMergeConflictsResponse Bool Source #

A Boolean value that indicates whether the code is mergeable by the specified merge option.

getMergeConflictsResponse_destinationCommitId :: Lens' GetMergeConflictsResponse Text Source #

The commit ID of the destination commit specifier that was used in the merge evaluation.

getMergeConflictsResponse_sourceCommitId :: Lens' GetMergeConflictsResponse Text Source #

The commit ID of the source commit specifier that was used in the merge evaluation.

getMergeConflictsResponse_conflictMetadataList :: Lens' GetMergeConflictsResponse [ConflictMetadata] Source #

A list of metadata for any conflicting files. If the specified merge strategy is FAST_FORWARD_MERGE, this list is always empty.