Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference). Results can be limited to a specified path.
- getDifferences :: Text -> Text -> GetDifferences
- data GetDifferences
- gdAfterPath :: Lens' GetDifferences (Maybe Text)
- gdNextToken :: Lens' GetDifferences (Maybe Text)
- gdBeforeCommitSpecifier :: Lens' GetDifferences (Maybe Text)
- gdBeforePath :: Lens' GetDifferences (Maybe Text)
- gdMaxResults :: Lens' GetDifferences (Maybe Int)
- gdRepositoryName :: Lens' GetDifferences Text
- gdAfterCommitSpecifier :: Lens' GetDifferences Text
- getDifferencesResponse :: Int -> GetDifferencesResponse
- data GetDifferencesResponse
- gdrsNextToken :: Lens' GetDifferencesResponse (Maybe Text)
- gdrsDifferences :: Lens' GetDifferencesResponse [Difference]
- gdrsResponseStatus :: Lens' GetDifferencesResponse Int
Creating a Request
Creates a value of GetDifferences
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdAfterPath
- The file path in which to check differences. Limits the results to this path. Can also be used to specify the changed name of a directory or folder, if it has changed. If not specified, differences will be shown for all paths.gdNextToken
- An enumeration token that when provided in a request, returns the next batch of the results.gdBeforeCommitSpecifier
- The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, the full commit ID. Optional. If not specified, all changes prior to theafterCommitSpecifier
value will be shown. If you do not usebeforeCommitSpecifier
in your request, consider limiting the results withmaxResults
.gdBeforePath
- The file path in which to check for differences. Limits the results to this path. Can also be used to specify the previous name of a directory or folder. IfbeforePath
andafterPath
are not specified, differences will be shown for all paths.gdMaxResults
- A non-negative integer used to limit the number of returned results.gdRepositoryName
- The name of the repository where you want to get differences.gdAfterCommitSpecifier
- The branch, tag, HEAD, or other fully qualified reference used to identify a commit.
data GetDifferences Source #
See: getDifferences
smart constructor.
Request Lenses
gdAfterPath :: Lens' GetDifferences (Maybe Text) Source #
The file path in which to check differences. Limits the results to this path. Can also be used to specify the changed name of a directory or folder, if it has changed. If not specified, differences will be shown for all paths.
gdNextToken :: Lens' GetDifferences (Maybe Text) Source #
An enumeration token that when provided in a request, returns the next batch of the results.
gdBeforeCommitSpecifier :: Lens' GetDifferences (Maybe Text) Source #
The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, the full commit ID. Optional. If not specified, all changes prior to the afterCommitSpecifier
value will be shown. If you do not use beforeCommitSpecifier
in your request, consider limiting the results with maxResults
.
gdBeforePath :: Lens' GetDifferences (Maybe Text) Source #
The file path in which to check for differences. Limits the results to this path. Can also be used to specify the previous name of a directory or folder. If beforePath
and afterPath
are not specified, differences will be shown for all paths.
gdMaxResults :: Lens' GetDifferences (Maybe Int) Source #
A non-negative integer used to limit the number of returned results.
gdRepositoryName :: Lens' GetDifferences Text Source #
The name of the repository where you want to get differences.
gdAfterCommitSpecifier :: Lens' GetDifferences Text Source #
The branch, tag, HEAD, or other fully qualified reference used to identify a commit.
Destructuring the Response
getDifferencesResponse Source #
Creates a value of GetDifferencesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdrsNextToken
- An enumeration token that can be used in a request to return the next batch of the results.gdrsDifferences
- A differences data type object that contains information about the differences, including whether the difference is added, modified, or deleted (A, D, M).gdrsResponseStatus
- -- | The response status code.
data GetDifferencesResponse Source #
See: getDifferencesResponse
smart constructor.
Response Lenses
gdrsNextToken :: Lens' GetDifferencesResponse (Maybe Text) Source #
An enumeration token that can be used in a request to return the next batch of the results.
gdrsDifferences :: Lens' GetDifferencesResponse [Difference] Source #
A differences data type object that contains information about the differences, including whether the difference is added, modified, or deleted (A, D, M).
gdrsResponseStatus :: Lens' GetDifferencesResponse Int Source #
- - | The response status code.