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.Documents.ListCollectionIds

Contents

REST Resource
Creating a Request
Request Lenses

Description

Lists all the collection IDs underneath a document.

See: Cloud Firestore API Reference for firestore.projects.databases.documents.listCollectionIds.

Synopsis

type ProjectsDatabasesDocumentsListCollectionIdsResource = "v1" :> (CaptureMode "parent" "listCollectionIds" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ListCollectionIdsRequest :> Post '[JSON] ListCollectionIdsResponse))))))))
projectsDatabasesDocumentsListCollectionIds :: Text -> ListCollectionIdsRequest -> ProjectsDatabasesDocumentsListCollectionIds
data ProjectsDatabasesDocumentsListCollectionIds
pddlciParent :: Lens' ProjectsDatabasesDocumentsListCollectionIds Text
pddlciXgafv :: Lens' ProjectsDatabasesDocumentsListCollectionIds (Maybe Xgafv)
pddlciUploadProtocol :: Lens' ProjectsDatabasesDocumentsListCollectionIds (Maybe Text)
pddlciAccessToken :: Lens' ProjectsDatabasesDocumentsListCollectionIds (Maybe Text)
pddlciUploadType :: Lens' ProjectsDatabasesDocumentsListCollectionIds (Maybe Text)
pddlciPayload :: Lens' ProjectsDatabasesDocumentsListCollectionIds ListCollectionIdsRequest
pddlciCallback :: Lens' ProjectsDatabasesDocumentsListCollectionIds (Maybe Text)

REST Resource

type ProjectsDatabasesDocumentsListCollectionIdsResource = "v1" :> (CaptureMode "parent" "listCollectionIds" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ListCollectionIdsRequest :> Post '[JSON] ListCollectionIdsResponse)))))))) Source #

A resource alias for firestore.projects.databases.documents.listCollectionIds method which the ProjectsDatabasesDocumentsListCollectionIds request conforms to.

Creating a Request

projectsDatabasesDocumentsListCollectionIds Source #

Arguments

:: Text	`pddlciParent`
-> ListCollectionIdsRequest	`pddlciPayload`
-> ProjectsDatabasesDocumentsListCollectionIds

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

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

data ProjectsDatabasesDocumentsListCollectionIds Source #

Lists all the collection IDs underneath a document.

See: projectsDatabasesDocumentsListCollectionIds smart constructor.

Instances

Eq ProjectsDatabasesDocumentsListCollectionIds Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.ListCollectionIds Methods (==) :: ProjectsDatabasesDocumentsListCollectionIds -> ProjectsDatabasesDocumentsListCollectionIds -> Bool # (/=) :: ProjectsDatabasesDocumentsListCollectionIds -> ProjectsDatabasesDocumentsListCollectionIds -> Bool #
Data ProjectsDatabasesDocumentsListCollectionIds Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.ListCollectionIds Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsDatabasesDocumentsListCollectionIds -> c ProjectsDatabasesDocumentsListCollectionIds # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsDatabasesDocumentsListCollectionIds # toConstr :: ProjectsDatabasesDocumentsListCollectionIds -> Constr # dataTypeOf :: ProjectsDatabasesDocumentsListCollectionIds -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsDatabasesDocumentsListCollectionIds) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsDatabasesDocumentsListCollectionIds) # gmapT :: (forall b. Data b => b -> b) -> ProjectsDatabasesDocumentsListCollectionIds -> ProjectsDatabasesDocumentsListCollectionIds # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesDocumentsListCollectionIds -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesDocumentsListCollectionIds -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsDatabasesDocumentsListCollectionIds -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsDatabasesDocumentsListCollectionIds -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsDatabasesDocumentsListCollectionIds -> m ProjectsDatabasesDocumentsListCollectionIds # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesDocumentsListCollectionIds -> m ProjectsDatabasesDocumentsListCollectionIds # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesDocumentsListCollectionIds -> m ProjectsDatabasesDocumentsListCollectionIds #
Show ProjectsDatabasesDocumentsListCollectionIds Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.ListCollectionIds Methods showsPrec :: Int -> ProjectsDatabasesDocumentsListCollectionIds -> ShowS # show :: ProjectsDatabasesDocumentsListCollectionIds -> String # showList :: [ProjectsDatabasesDocumentsListCollectionIds] -> ShowS #
Generic ProjectsDatabasesDocumentsListCollectionIds Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.ListCollectionIds Associated Types type Rep ProjectsDatabasesDocumentsListCollectionIds :: Type -> Type # Methods from :: ProjectsDatabasesDocumentsListCollectionIds -> Rep ProjectsDatabasesDocumentsListCollectionIds x # to :: Rep ProjectsDatabasesDocumentsListCollectionIds x -> ProjectsDatabasesDocumentsListCollectionIds #
GoogleRequest ProjectsDatabasesDocumentsListCollectionIds Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.ListCollectionIds Associated Types type Rs ProjectsDatabasesDocumentsListCollectionIds :: Type # type Scopes ProjectsDatabasesDocumentsListCollectionIds :: [Symbol] # Methods requestClient :: ProjectsDatabasesDocumentsListCollectionIds -> GClient (Rs ProjectsDatabasesDocumentsListCollectionIds) #
type Rep ProjectsDatabasesDocumentsListCollectionIds Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.ListCollectionIds type Rep ProjectsDatabasesDocumentsListCollectionIds = D1 (MetaData "ProjectsDatabasesDocumentsListCollectionIds" "Network.Google.Resource.FireStore.Projects.Databases.Documents.ListCollectionIds" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "ProjectsDatabasesDocumentsListCollectionIds'" PrefixI True) ((S1 (MetaSel (Just "_pddlciParent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_pddlciXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_pddlciUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_pddlciAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pddlciUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_pddlciPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ListCollectionIdsRequest) :: S1 (MetaSel (Just "_pddlciCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsDatabasesDocumentsListCollectionIds Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.ListCollectionIds type Scopes ProjectsDatabasesDocumentsListCollectionIds = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/datastore" ': ([] :: [Symbol]))
type Rs ProjectsDatabasesDocumentsListCollectionIds Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.ListCollectionIds type Rs ProjectsDatabasesDocumentsListCollectionIds = ListCollectionIdsResponse

Request Lenses

pddlciParent :: Lens' ProjectsDatabasesDocumentsListCollectionIds Text Source #

The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

pddlciXgafv :: Lens' ProjectsDatabasesDocumentsListCollectionIds (Maybe Xgafv) Source #

V1 error format.

pddlciUploadProtocol :: Lens' ProjectsDatabasesDocumentsListCollectionIds (Maybe Text) Source #

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

pddlciAccessToken :: Lens' ProjectsDatabasesDocumentsListCollectionIds (Maybe Text) Source #

OAuth access token.

pddlciUploadType :: Lens' ProjectsDatabasesDocumentsListCollectionIds (Maybe Text) Source #

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

pddlciPayload :: Lens' ProjectsDatabasesDocumentsListCollectionIds ListCollectionIdsRequest Source #

Multipart request metadata.

pddlciCallback :: Lens' ProjectsDatabasesDocumentsListCollectionIds (Maybe Text) Source #

JSONP