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.FireStore.Projects.Databases.CollectionGroups.Fields.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`.

See: Cloud Firestore API Reference for firestore.projects.databases.collectionGroups.fields.list.

Synopsis

type ProjectsDatabasesCollectionGroupsFieldsListResource = "v1" :> (Capture "parent" Text :> ("fields" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GoogleFirestoreAdminV1ListFieldsResponse)))))))))))
projectsDatabasesCollectionGroupsFieldsList :: Text -> ProjectsDatabasesCollectionGroupsFieldsList
data ProjectsDatabasesCollectionGroupsFieldsList
pdcgflParent :: Lens' ProjectsDatabasesCollectionGroupsFieldsList Text
pdcgflXgafv :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Xgafv)
pdcgflUploadProtocol :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Text)
pdcgflAccessToken :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Text)
pdcgflUploadType :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Text)
pdcgflFilter :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Text)
pdcgflPageToken :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Text)
pdcgflPageSize :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Int32)
pdcgflCallback :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Text)

REST Resource

type ProjectsDatabasesCollectionGroupsFieldsListResource = "v1" :> (Capture "parent" Text :> ("fields" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GoogleFirestoreAdminV1ListFieldsResponse))))))))))) Source #

A resource alias for firestore.projects.databases.collectionGroups.fields.list method which the ProjectsDatabasesCollectionGroupsFieldsList request conforms to.

Creating a Request

projectsDatabasesCollectionGroupsFieldsList Source #

Arguments

:: Text	`pdcgflParent`
-> ProjectsDatabasesCollectionGroupsFieldsList

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

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

data ProjectsDatabasesCollectionGroupsFieldsList Source #

Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`.

See: projectsDatabasesCollectionGroupsFieldsList smart constructor.

Instances

Eq ProjectsDatabasesCollectionGroupsFieldsList Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.List Methods (==) :: ProjectsDatabasesCollectionGroupsFieldsList -> ProjectsDatabasesCollectionGroupsFieldsList -> Bool # (/=) :: ProjectsDatabasesCollectionGroupsFieldsList -> ProjectsDatabasesCollectionGroupsFieldsList -> Bool #
Data ProjectsDatabasesCollectionGroupsFieldsList Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsDatabasesCollectionGroupsFieldsList -> c ProjectsDatabasesCollectionGroupsFieldsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsDatabasesCollectionGroupsFieldsList # toConstr :: ProjectsDatabasesCollectionGroupsFieldsList -> Constr # dataTypeOf :: ProjectsDatabasesCollectionGroupsFieldsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsDatabasesCollectionGroupsFieldsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsDatabasesCollectionGroupsFieldsList) # gmapT :: (forall b. Data b => b -> b) -> ProjectsDatabasesCollectionGroupsFieldsList -> ProjectsDatabasesCollectionGroupsFieldsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesCollectionGroupsFieldsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesCollectionGroupsFieldsList -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsDatabasesCollectionGroupsFieldsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsDatabasesCollectionGroupsFieldsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsDatabasesCollectionGroupsFieldsList -> m ProjectsDatabasesCollectionGroupsFieldsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesCollectionGroupsFieldsList -> m ProjectsDatabasesCollectionGroupsFieldsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesCollectionGroupsFieldsList -> m ProjectsDatabasesCollectionGroupsFieldsList #
Show ProjectsDatabasesCollectionGroupsFieldsList Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.List Methods showsPrec :: Int -> ProjectsDatabasesCollectionGroupsFieldsList -> ShowS # show :: ProjectsDatabasesCollectionGroupsFieldsList -> String # showList :: [ProjectsDatabasesCollectionGroupsFieldsList] -> ShowS #
Generic ProjectsDatabasesCollectionGroupsFieldsList Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.List Associated Types type Rep ProjectsDatabasesCollectionGroupsFieldsList :: Type -> Type # Methods from :: ProjectsDatabasesCollectionGroupsFieldsList -> Rep ProjectsDatabasesCollectionGroupsFieldsList x # to :: Rep ProjectsDatabasesCollectionGroupsFieldsList x -> ProjectsDatabasesCollectionGroupsFieldsList #
GoogleRequest ProjectsDatabasesCollectionGroupsFieldsList Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.List Associated Types type Rs ProjectsDatabasesCollectionGroupsFieldsList :: Type # type Scopes ProjectsDatabasesCollectionGroupsFieldsList :: [Symbol] # Methods requestClient :: ProjectsDatabasesCollectionGroupsFieldsList -> GClient (Rs ProjectsDatabasesCollectionGroupsFieldsList) #
type Rep ProjectsDatabasesCollectionGroupsFieldsList Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.List type Rep ProjectsDatabasesCollectionGroupsFieldsList = D1 (MetaData "ProjectsDatabasesCollectionGroupsFieldsList" "Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.List" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "ProjectsDatabasesCollectionGroupsFieldsList'" PrefixI True) (((S1 (MetaSel (Just "_pdcgflParent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_pdcgflXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) :: (S1 (MetaSel (Just "_pdcgflUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pdcgflAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_pdcgflUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pdcgflFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_pdcgflPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_pdcgflPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :: S1 (MetaSel (Just "_pdcgflCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes ProjectsDatabasesCollectionGroupsFieldsList Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.List type Scopes ProjectsDatabasesCollectionGroupsFieldsList = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/datastore" ': ([] :: [Symbol]))
type Rs ProjectsDatabasesCollectionGroupsFieldsList Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.List type Rs ProjectsDatabasesCollectionGroupsFieldsList = GoogleFirestoreAdminV1ListFieldsResponse

Request Lenses

pdcgflParent :: Lens' ProjectsDatabasesCollectionGroupsFieldsList Text Source #

A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`

pdcgflXgafv :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Xgafv) Source #

V1 error format.

pdcgflUploadProtocol :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Text) Source #

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

pdcgflAccessToken :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Text) Source #

OAuth access token.

pdcgflUploadType :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Text) Source #

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

pdcgflFilter :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Text) Source #

The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`.

pdcgflPageToken :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Text) Source #

A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.

pdcgflPageSize :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Int32) Source #

The number of results to return.

pdcgflCallback :: Lens' ProjectsDatabasesCollectionGroupsFieldsList (Maybe Text) Source #

JSONP