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