{-# LANGUAGE DataKinds          #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE DeriveGeneric      #-}
{-# LANGUAGE FlexibleInstances  #-}
{-# LANGUAGE NoImplicitPrelude  #-}
{-# LANGUAGE OverloadedStrings  #-}
{-# LANGUAGE RecordWildCards    #-}
{-# LANGUAGE TypeFamilies       #-}
{-# LANGUAGE TypeOperators      #-}

{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# OPTIONS_GHC -fno-warn-unused-binds      #-}
{-# OPTIONS_GHC -fno-warn-unused-imports    #-}

-- |
-- Module      : Network.Google.Resource.CloudResourceManager.Projects.List
-- 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)
--
-- Lists Projects that are visible to the user and satisfy the specified
-- filter. This method returns Projects in an unspecified order. New
-- Projects do not necessarily appear at the end of the list.
--
-- /See:/ <https://cloud.google.com/resource-manager Google Cloud Resource Manager API Reference> for @cloudresourcemanager.projects.list@.
module Network.Google.Resource.CloudResourceManager.Projects.List
    (
    -- * REST Resource
      ProjectsListResource

    -- * Creating a Request
    , projectsList
    , ProjectsList

    -- * Request Lenses
    , plXgafv
    , plUploadProtocol
    , plPp
    , plAccessToken
    , plUploadType
    , plBearerToken
    , plFilter
    , plPageToken
    , plPageSize
    , plCallback
    ) where

import           Network.Google.Prelude
import           Network.Google.ResourceManager.Types

-- | A resource alias for @cloudresourcemanager.projects.list@ method which the
-- 'ProjectsList' request conforms to.
type ProjectsListResource =
     "v1" :>
       "projects" :>
         QueryParam "$.xgafv" Xgafv :>
           QueryParam "upload_protocol" Text :>
             QueryParam "pp" Bool :>
               QueryParam "access_token" Text :>
                 QueryParam "uploadType" Text :>
                   QueryParam "bearer_token" Text :>
                     QueryParam "filter" Text :>
                       QueryParam "pageToken" Text :>
                         QueryParam "pageSize" (Textual Int32) :>
                           QueryParam "callback" Text :>
                             QueryParam "alt" AltJSON :>
                               Get '[JSON] ListProjectsResponse

-- | Lists Projects that are visible to the user and satisfy the specified
-- filter. This method returns Projects in an unspecified order. New
-- Projects do not necessarily appear at the end of the list.
--
-- /See:/ 'projectsList' smart constructor.
data ProjectsList = ProjectsList'
    { _plXgafv          :: !(Maybe Xgafv)
    , _plUploadProtocol :: !(Maybe Text)
    , _plPp             :: !Bool
    , _plAccessToken    :: !(Maybe Text)
    , _plUploadType     :: !(Maybe Text)
    , _plBearerToken    :: !(Maybe Text)
    , _plFilter         :: !(Maybe Text)
    , _plPageToken      :: !(Maybe Text)
    , _plPageSize       :: !(Maybe (Textual Int32))
    , _plCallback       :: !(Maybe Text)
    } deriving (Eq,Show,Data,Typeable,Generic)

-- | Creates a value of 'ProjectsList' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'plXgafv'
--
-- * 'plUploadProtocol'
--
-- * 'plPp'
--
-- * 'plAccessToken'
--
-- * 'plUploadType'
--
-- * 'plBearerToken'
--
-- * 'plFilter'
--
-- * 'plPageToken'
--
-- * 'plPageSize'
--
-- * 'plCallback'
projectsList
    :: ProjectsList
projectsList =
    ProjectsList'
    { _plXgafv = Nothing
    , _plUploadProtocol = Nothing
    , _plPp = True
    , _plAccessToken = Nothing
    , _plUploadType = Nothing
    , _plBearerToken = Nothing
    , _plFilter = Nothing
    , _plPageToken = Nothing
    , _plPageSize = Nothing
    , _plCallback = Nothing
    }

-- | V1 error format.
plXgafv :: Lens' ProjectsList (Maybe Xgafv)
plXgafv = lens _plXgafv (\ s a -> s{_plXgafv = a})

-- | Upload protocol for media (e.g. \"raw\", \"multipart\").
plUploadProtocol :: Lens' ProjectsList (Maybe Text)
plUploadProtocol
  = lens _plUploadProtocol
      (\ s a -> s{_plUploadProtocol = a})

-- | Pretty-print response.
plPp :: Lens' ProjectsList Bool
plPp = lens _plPp (\ s a -> s{_plPp = a})

-- | OAuth access token.
plAccessToken :: Lens' ProjectsList (Maybe Text)
plAccessToken
  = lens _plAccessToken
      (\ s a -> s{_plAccessToken = a})

-- | Legacy upload protocol for media (e.g. \"media\", \"multipart\").
plUploadType :: Lens' ProjectsList (Maybe Text)
plUploadType
  = lens _plUploadType (\ s a -> s{_plUploadType = a})

-- | OAuth bearer token.
plBearerToken :: Lens' ProjectsList (Maybe Text)
plBearerToken
  = lens _plBearerToken
      (\ s a -> s{_plBearerToken = a})

-- | An expression for filtering the results of the request. Filter rules are
-- case insensitive. The fields eligible for filtering are: + \`name\` +
-- \`id\` + 'labels.key' where *key* is the name of a label Some examples
-- of using labels as filters: |Filter|Description| |------|-----------|
-- |name:*|The project has a name.| |name:Howl|The project\'s name is
-- \`Howl\` or \`howl\`.| |name:HOWL|Equivalent to above.|
-- |NAME:howl|Equivalent to above.| |labels.color:*|The project has the
-- label \`color\`.| |labels.color:red|The project\'s label \`color\` has
-- the value \`red\`.| |labels.color:red label.size:big|The project\'s
-- label \`color\` has the value \`red\` and its label \`size\` has the
-- value \`big\`. Optional.
plFilter :: Lens' ProjectsList (Maybe Text)
plFilter = lens _plFilter (\ s a -> s{_plFilter = a})

-- | A pagination token returned from a previous call to ListProjects that
-- indicates from where listing should continue. Optional.
plPageToken :: Lens' ProjectsList (Maybe Text)
plPageToken
  = lens _plPageToken (\ s a -> s{_plPageToken = a})

-- | The maximum number of Projects to return in the response. The server can
-- return fewer Projects than requested. If unspecified, server picks an
-- appropriate default. Optional.
plPageSize :: Lens' ProjectsList (Maybe Int32)
plPageSize
  = lens _plPageSize (\ s a -> s{_plPageSize = a}) .
      mapping _Coerce

-- | JSONP
plCallback :: Lens' ProjectsList (Maybe Text)
plCallback
  = lens _plCallback (\ s a -> s{_plCallback = a})

instance GoogleRequest ProjectsList where
        type Rs ProjectsList = ListProjectsResponse
        type Scopes ProjectsList =
             '["https://www.googleapis.com/auth/cloud-platform",
               "https://www.googleapis.com/auth/cloud-platform.read-only"]
        requestClient ProjectsList'{..}
          = go _plXgafv _plUploadProtocol (Just _plPp)
              _plAccessToken
              _plUploadType
              _plBearerToken
              _plFilter
              _plPageToken
              _plPageSize
              _plCallback
              (Just AltJSON)
              resourceManagerService
          where go
                  = buildClient (Proxy :: Proxy ProjectsListResource)
                      mempty