Copyright	(c) 2013-2021 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

Amazonka.CodeCommit.GetFolder

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the contents of a specified folder in a repository.

Synopsis

data GetFolder = GetFolder' {
- commitSpecifier :: Maybe Text
- repositoryName :: Text
- folderPath :: Text
}
newGetFolder :: Text -> Text -> GetFolder
getFolder_commitSpecifier :: Lens' GetFolder (Maybe Text)
getFolder_repositoryName :: Lens' GetFolder Text
getFolder_folderPath :: Lens' GetFolder Text
data GetFolderResponse = GetFolderResponse' {
- subModules :: Maybe [SubModule]
- treeId :: Maybe Text
- subFolders :: Maybe [Folder]
- symbolicLinks :: Maybe [SymbolicLink]
- files :: Maybe [File]
- httpStatus :: Int
- commitId :: Text
- folderPath :: Text
}
newGetFolderResponse :: Int -> Text -> Text -> GetFolderResponse
getFolderResponse_subModules :: Lens' GetFolderResponse (Maybe [SubModule])
getFolderResponse_treeId :: Lens' GetFolderResponse (Maybe Text)
getFolderResponse_subFolders :: Lens' GetFolderResponse (Maybe [Folder])
getFolderResponse_symbolicLinks :: Lens' GetFolderResponse (Maybe [SymbolicLink])
getFolderResponse_files :: Lens' GetFolderResponse (Maybe [File])
getFolderResponse_httpStatus :: Lens' GetFolderResponse Int
getFolderResponse_commitId :: Lens' GetFolderResponse Text
getFolderResponse_folderPath :: Lens' GetFolderResponse Text

Creating a Request

data GetFolder Source #

See: newGetFolder smart constructor.

Constructors

GetFolder'

Fields

commitSpecifier :: Maybe Text
A fully qualified reference used to identify a commit that contains the version of the folder's content to return. A fully qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no specifier is provided, the folder content is returned as it exists in the HEAD commit.
repositoryName :: Text
The name of the repository.
folderPath :: Text
The fully qualified path to the folder whose contents are returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository.

Instances

Instances details

Eq GetFolder Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Methods (==) :: GetFolder -> GetFolder -> Bool # (/=) :: GetFolder -> GetFolder -> Bool #
Read GetFolder Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Methods readsPrec :: Int -> ReadS GetFolder # readList :: ReadS [GetFolder] # readPrec :: ReadPrec GetFolder # readListPrec :: ReadPrec [GetFolder] #
Show GetFolder Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Methods showsPrec :: Int -> GetFolder -> ShowS # show :: GetFolder -> String # showList :: [GetFolder] -> ShowS #
Generic GetFolder Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Associated Types type Rep GetFolder :: Type -> Type # Methods from :: GetFolder -> Rep GetFolder x # to :: Rep GetFolder x -> GetFolder #
NFData GetFolder Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Methods rnf :: GetFolder -> () #
Hashable GetFolder Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Methods hashWithSalt :: Int -> GetFolder -> Int # hash :: GetFolder -> Int #
ToJSON GetFolder Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Methods toJSON :: GetFolder -> Value # toEncoding :: GetFolder -> Encoding # toJSONList :: [GetFolder] -> Value # toEncodingList :: [GetFolder] -> Encoding #
AWSRequest GetFolder Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Associated Types type AWSResponse GetFolder # Methods request :: GetFolder -> Request GetFolder # response :: MonadResource m => Logger -> Service -> Proxy GetFolder -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetFolder))) #
ToHeaders GetFolder Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Methods toHeaders :: GetFolder -> [Header] #
ToPath GetFolder Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Methods toPath :: GetFolder -> ByteString #
ToQuery GetFolder Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Methods toQuery :: GetFolder -> QueryString #
type Rep GetFolder Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder type Rep GetFolder = D1 ('MetaData "GetFolder" "Amazonka.CodeCommit.GetFolder" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "GetFolder'" 'PrefixI 'True) (S1 ('MetaSel ('Just "commitSpecifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "folderPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetFolder Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder type AWSResponse GetFolder = GetFolderResponse

newGetFolder Source #

Arguments

:: Text	`$sel:repositoryName:GetFolder'`
-> Text	`$sel:folderPath:GetFolder'`
-> GetFolder

Create a value of GetFolder 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:commitSpecifier:GetFolder', getFolder_commitSpecifier - A fully qualified reference used to identify a commit that contains the version of the folder's content to return. A fully qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no specifier is provided, the folder content is returned as it exists in the HEAD commit.

$sel:repositoryName:GetFolder', getFolder_repositoryName - The name of the repository.

$sel:folderPath:GetFolder', getFolder_folderPath - The fully qualified path to the folder whose contents are returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository.

Request Lenses

getFolder_commitSpecifier :: Lens' GetFolder (Maybe Text) Source #

A fully qualified reference used to identify a commit that contains the version of the folder's content to return. A fully qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no specifier is provided, the folder content is returned as it exists in the HEAD commit.

getFolder_repositoryName :: Lens' GetFolder Text Source #

The name of the repository.

getFolder_folderPath :: Lens' GetFolder Text Source #

The fully qualified path to the folder whose contents are returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository.

Destructuring the Response

data GetFolderResponse Source #

See: newGetFolderResponse smart constructor.

Constructors

GetFolderResponse'

Fields

subModules :: Maybe [SubModule]
The list of submodules in the specified folder, if any.
treeId :: Maybe Text
The full SHA-1 pointer of the tree information for the commit that contains the folder.
subFolders :: Maybe [Folder]
The list of folders that exist under the specified folder, if any.
symbolicLinks :: Maybe [SymbolicLink]
The list of symbolic links to other files and folders in the specified folder, if any.
files :: Maybe [File]
The list of files in the specified folder, if any.
httpStatus :: Int
The response's http status code.
commitId :: Text
The full commit ID used as a reference for the returned version of the folder content.
folderPath :: Text
The fully qualified path of the folder whose contents are returned.

Instances

Instances details

Eq GetFolderResponse Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Methods (==) :: GetFolderResponse -> GetFolderResponse -> Bool # (/=) :: GetFolderResponse -> GetFolderResponse -> Bool #
Read GetFolderResponse Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Methods readsPrec :: Int -> ReadS GetFolderResponse # readList :: ReadS [GetFolderResponse] # readPrec :: ReadPrec GetFolderResponse # readListPrec :: ReadPrec [GetFolderResponse] #
Show GetFolderResponse Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Methods showsPrec :: Int -> GetFolderResponse -> ShowS # show :: GetFolderResponse -> String # showList :: [GetFolderResponse] -> ShowS #
Generic GetFolderResponse Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Associated Types type Rep GetFolderResponse :: Type -> Type # Methods from :: GetFolderResponse -> Rep GetFolderResponse x # to :: Rep GetFolderResponse x -> GetFolderResponse #
NFData GetFolderResponse Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder Methods rnf :: GetFolderResponse -> () #
type Rep GetFolderResponse Source #
Instance details Defined in Amazonka.CodeCommit.GetFolder type Rep GetFolderResponse = D1 ('MetaData "GetFolderResponse" "Amazonka.CodeCommit.GetFolder" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "GetFolderResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "subModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubModule])) :: S1 ('MetaSel ('Just "treeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "subFolders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Folder])) :: S1 ('MetaSel ('Just "symbolicLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SymbolicLink])))) :: ((S1 ('MetaSel ('Just "files") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [File])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "commitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "folderPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetFolderResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetFolderResponse'`
-> Text	`$sel:commitId:GetFolderResponse'`
-> Text	`$sel:folderPath:GetFolder'`
-> GetFolderResponse

Create a value of GetFolderResponse 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:subModules:GetFolderResponse', getFolderResponse_subModules - The list of submodules in the specified folder, if any.

$sel:treeId:GetFolderResponse', getFolderResponse_treeId - The full SHA-1 pointer of the tree information for the commit that contains the folder.

$sel:subFolders:GetFolderResponse', getFolderResponse_subFolders - The list of folders that exist under the specified folder, if any.

$sel:symbolicLinks:GetFolderResponse', getFolderResponse_symbolicLinks - The list of symbolic links to other files and folders in the specified folder, if any.

$sel:files:GetFolderResponse', getFolderResponse_files - The list of files in the specified folder, if any.

$sel:httpStatus:GetFolderResponse', getFolderResponse_httpStatus - The response's http status code.

$sel:commitId:GetFolderResponse', getFolderResponse_commitId - The full commit ID used as a reference for the returned version of the folder content.

$sel:folderPath:GetFolder', getFolderResponse_folderPath - The fully qualified path of the folder whose contents are returned.

Response Lenses

getFolderResponse_subModules :: Lens' GetFolderResponse (Maybe [SubModule]) Source #

The list of submodules in the specified folder, if any.

getFolderResponse_treeId :: Lens' GetFolderResponse (Maybe Text) Source #

The full SHA-1 pointer of the tree information for the commit that contains the folder.

getFolderResponse_subFolders :: Lens' GetFolderResponse (Maybe [Folder]) Source #

The list of folders that exist under the specified folder, if any.

getFolderResponse_symbolicLinks :: Lens' GetFolderResponse (Maybe [SymbolicLink]) Source #

The list of symbolic links to other files and folders in the specified folder, if any.

getFolderResponse_files :: Lens' GetFolderResponse (Maybe [File]) Source #

The list of files in the specified folder, if any.

getFolderResponse_httpStatus :: Lens' GetFolderResponse Int Source #

The response's http status code.

getFolderResponse_commitId :: Lens' GetFolderResponse Text Source #

The full commit ID used as a reference for the returned version of the folder content.

getFolderResponse_folderPath :: Lens' GetFolderResponse Text Source #

The fully qualified path of the folder whose contents are returned.