Amazonka.CodeCommit.GetFolder

Returns the contents of a specified folder in a repository.

Creating a Request

data GetFolder

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

ToJSON GetFolder

Defined in Amazonka.CodeCommit.GetFolder

Methods

toJSON :: GetFolder -> Value

toEncoding :: GetFolder -> Encoding

toJSONList :: [GetFolder] -> Value

toEncodingList :: [GetFolder] -> Encoding

ToHeaders GetFolder

Defined in Amazonka.CodeCommit.GetFolder

Methods

toHeaders :: GetFolder -> [Header]

ToPath GetFolder

Defined in Amazonka.CodeCommit.GetFolder

Methods

toPath :: GetFolder -> ByteString

ToQuery GetFolder

Defined in Amazonka.CodeCommit.GetFolder

Methods

toQuery :: GetFolder -> QueryString

AWSRequest GetFolder

Defined in Amazonka.CodeCommit.GetFolder

Associated Types

type AWSResponse GetFolder

Methods

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

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

Generic GetFolder

Defined in Amazonka.CodeCommit.GetFolder

Associated Types

type Rep GetFolder :: Type -> Type

Methods

from :: GetFolder -> Rep GetFolder x

to :: Rep GetFolder x -> GetFolder

Read GetFolder

Defined in Amazonka.CodeCommit.GetFolder

Methods

readsPrec :: Int -> ReadS GetFolder

readList :: ReadS [GetFolder]

readPrec :: ReadPrec GetFolder

readListPrec :: ReadPrec [GetFolder]

Show GetFolder

Defined in Amazonka.CodeCommit.GetFolder

Methods

showsPrec :: Int -> GetFolder -> ShowS

show :: GetFolder -> String

showList :: [GetFolder] -> ShowS

NFData GetFolder

Defined in Amazonka.CodeCommit.GetFolder

Methods

rnf :: GetFolder -> ()

Eq GetFolder

Defined in Amazonka.CodeCommit.GetFolder

Methods

(==) :: GetFolder -> GetFolder -> Bool

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

Hashable GetFolder

Defined in Amazonka.CodeCommit.GetFolder

Methods

hashWithSalt :: Int -> GetFolder -> Int

hash :: GetFolder -> Int

type AWSResponse GetFolder

Defined in Amazonka.CodeCommit.GetFolder

type AWSResponse GetFolder = GetFolderResponse

type Rep GetFolder

Defined in Amazonka.CodeCommit.GetFolder

type Rep GetFolder = D1 ('MetaData "GetFolder" "Amazonka.CodeCommit.GetFolder" "amazonka-codecommit-2.0-974g5LOhuTPG9HgUSx02zG" '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))))

newGetFolder

Arguments

:: Text

GetFolder

-> Text

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.

GetFolder, getFolder_repositoryName - The name of the repository.

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)

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

The name of the repository.

getFolder_folderPath :: Lens' GetFolder 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.

Destructuring the Response

data GetFolderResponse

See: newGetFolderResponse smart constructor.

Constructors

GetFolderResponse'

Fields

• files :: Maybe [File]

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

• subFolders :: Maybe [Folder]

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

• subModules :: Maybe [SubModule]

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

• symbolicLinks :: Maybe [SymbolicLink]

  The list of symbolic links to other files and folders 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.

• 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

Generic GetFolderResponse

Defined in Amazonka.CodeCommit.GetFolder

Associated Types

type Rep GetFolderResponse :: Type -> Type

Methods

from :: GetFolderResponse -> Rep GetFolderResponse x

to :: Rep GetFolderResponse x -> GetFolderResponse

Read GetFolderResponse

Defined in Amazonka.CodeCommit.GetFolder

Methods

readsPrec :: Int -> ReadS GetFolderResponse

readList :: ReadS [GetFolderResponse]

readPrec :: ReadPrec GetFolderResponse

readListPrec :: ReadPrec [GetFolderResponse]

Show GetFolderResponse

Defined in Amazonka.CodeCommit.GetFolder

Methods

showsPrec :: Int -> GetFolderResponse -> ShowS

show :: GetFolderResponse -> String

showList :: [GetFolderResponse] -> ShowS

NFData GetFolderResponse

Defined in Amazonka.CodeCommit.GetFolder

Methods

rnf :: GetFolderResponse -> ()

Eq GetFolderResponse

Defined in Amazonka.CodeCommit.GetFolder

Methods

(==) :: GetFolderResponse -> GetFolderResponse -> Bool

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

type Rep GetFolderResponse

Defined in Amazonka.CodeCommit.GetFolder

type Rep GetFolderResponse = D1 ('MetaData "GetFolderResponse" "Amazonka.CodeCommit.GetFolder" "amazonka-codecommit-2.0-974g5LOhuTPG9HgUSx02zG" 'False) (C1 ('MetaCons "GetFolderResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "files") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [File])) :*: S1 ('MetaSel ('Just "subFolders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Folder]))) :*: (S1 ('MetaSel ('Just "subModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubModule])) :*: S1 ('MetaSel ('Just "symbolicLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SymbolicLink])))) :*: ((S1 ('MetaSel ('Just "treeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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

Arguments

:: Int

$sel:httpStatus:GetFolderResponse'

-> Text

GetFolderResponse

-> Text

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:files:GetFolderResponse', getFolderResponse_files - The list of files in the specified folder, if any.

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

$sel:subModules:GetFolderResponse', getFolderResponse_subModules - The list of submodules in 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.

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

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

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

GetFolder, getFolderResponse_folderPath - The fully qualified path of the folder whose contents are returned.

Response Lenses

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

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

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

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

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

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

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

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

getFolderResponse_treeId :: Lens' GetFolderResponse (Maybe Text)

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

getFolderResponse_httpStatus :: Lens' GetFolderResponse Int

The response's http status code.

getFolderResponse_commitId :: Lens' GetFolderResponse Text

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

getFolderResponse_folderPath :: Lens' GetFolderResponse Text

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