Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.CloudResourceManager.Folders.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Lists the Folders that are direct descendants of supplied parent resource. List provides a strongly consistent view of the Folders underneath the specified parent resource. List returns Folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have `resourcemanager.folders.list` permission on the identified parent.

See: Cloud Resource Manager API Reference for cloudresourcemanager.folders.list.

Synopsis

type FoldersListResource = "v2" :> ("folders" :> (QueryParam "parent" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "showDeleted" Bool :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListFoldersResponse)))))))))))
foldersList :: FoldersList
data FoldersList
flParent :: Lens' FoldersList (Maybe Text)
flXgafv :: Lens' FoldersList (Maybe Xgafv)
flUploadProtocol :: Lens' FoldersList (Maybe Text)
flAccessToken :: Lens' FoldersList (Maybe Text)
flUploadType :: Lens' FoldersList (Maybe Text)
flShowDeleted :: Lens' FoldersList (Maybe Bool)
flPageToken :: Lens' FoldersList (Maybe Text)
flPageSize :: Lens' FoldersList (Maybe Int32)
flCallback :: Lens' FoldersList (Maybe Text)

REST Resource

type FoldersListResource = "v2" :> ("folders" :> (QueryParam "parent" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "showDeleted" Bool :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListFoldersResponse))))))))))) Source #

A resource alias for cloudresourcemanager.folders.list method which the FoldersList request conforms to.

Creating a Request

foldersList :: FoldersList Source #

Creates a value of FoldersList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data FoldersList Source #

Lists the Folders that are direct descendants of supplied parent resource. List provides a strongly consistent view of the Folders underneath the specified parent resource. List returns Folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have `resourcemanager.folders.list` permission on the identified parent.

See: foldersList smart constructor.

Instances

Eq FoldersList Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.List Methods (==) :: FoldersList -> FoldersList -> Bool # (/=) :: FoldersList -> FoldersList -> Bool #
Data FoldersList Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FoldersList -> c FoldersList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FoldersList # toConstr :: FoldersList -> Constr # dataTypeOf :: FoldersList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FoldersList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FoldersList) # gmapT :: (forall b. Data b => b -> b) -> FoldersList -> FoldersList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FoldersList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FoldersList -> r # gmapQ :: (forall d. Data d => d -> u) -> FoldersList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> FoldersList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> FoldersList -> m FoldersList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FoldersList -> m FoldersList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FoldersList -> m FoldersList #
Show FoldersList Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.List Methods showsPrec :: Int -> FoldersList -> ShowS # show :: FoldersList -> String # showList :: [FoldersList] -> ShowS #
Generic FoldersList Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.List Associated Types type Rep FoldersList :: Type -> Type # Methods from :: FoldersList -> Rep FoldersList x # to :: Rep FoldersList x -> FoldersList #
GoogleRequest FoldersList Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.List Associated Types type Rs FoldersList :: Type # type Scopes FoldersList :: [Symbol] # Methods requestClient :: FoldersList -> GClient (Rs FoldersList) #
type Rep FoldersList Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.List type Rep FoldersList = D1 (MetaData "FoldersList" "Network.Google.Resource.CloudResourceManager.Folders.List" "gogol-resourcemanager-0.4.0-UDFVnkFAEA9efzG80swCH" False) (C1 (MetaCons "FoldersList'" PrefixI True) (((S1 (MetaSel (Just "_flParent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_flXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) :: (S1 (MetaSel (Just "_flUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_flAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_flUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_flShowDeleted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 (MetaSel (Just "_flPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_flPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :: S1 (MetaSel (Just "_flCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes FoldersList Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.List type Scopes FoldersList = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/cloud-platform.read-only" ': ([] :: [Symbol]))
type Rs FoldersList Source #
Instance details Defined in Network.Google.Resource.CloudResourceManager.Folders.List type Rs FoldersList = ListFoldersResponse

Request Lenses

flParent :: Lens' FoldersList (Maybe Text) Source #

The resource name of the Organization or Folder whose Folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`.

flXgafv :: Lens' FoldersList (Maybe Xgafv) Source #

V1 error format.

flUploadProtocol :: Lens' FoldersList (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

flAccessToken :: Lens' FoldersList (Maybe Text) Source #

OAuth access token.

flUploadType :: Lens' FoldersList (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

flShowDeleted :: Lens' FoldersList (Maybe Bool) Source #

Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false. This field is optional.

flPageToken :: Lens' FoldersList (Maybe Text) Source #

A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from. This field is optional.

flPageSize :: Lens' FoldersList (Maybe Int32) Source #

The maximum number of Folders to return in the response. This field is optional.

flCallback :: Lens' FoldersList (Maybe Text) Source #

JSONP