gogol-firestore-0.4.0: Google Cloud Firestore SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.FireStore.Projects.Databases.Documents.BatchGet

Contents

Description

Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

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

Synopsis

REST Resource

type ProjectsDatabasesDocumentsBatchGetResource = "v1" :> (Capture "database" Text :> ("documents:batchGet" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] BatchGetDocumentsRequest :> Post '[JSON] BatchGetDocumentsResponse))))))))) Source #

A resource alias for firestore.projects.databases.documents.batchGet method which the ProjectsDatabasesDocumentsBatchGet request conforms to.

Creating a Request

projectsDatabasesDocumentsBatchGet Source #

Arguments

:: Text

pddbgDatabase

-> BatchGetDocumentsRequest

pddbgPayload

-> ProjectsDatabasesDocumentsBatchGet 

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

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

data ProjectsDatabasesDocumentsBatchGet Source #

Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

See: projectsDatabasesDocumentsBatchGet smart constructor.

Instances
Eq ProjectsDatabasesDocumentsBatchGet Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.BatchGet

Methods

(==) :: ProjectsDatabasesDocumentsBatchGet -> ProjectsDatabasesDocumentsBatchGet -> Bool #

(/=) :: ProjectsDatabasesDocumentsBatchGet -> ProjectsDatabasesDocumentsBatchGet -> Bool #

Data ProjectsDatabasesDocumentsBatchGet Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.BatchGet

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsDatabasesDocumentsBatchGet -> c ProjectsDatabasesDocumentsBatchGet #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsDatabasesDocumentsBatchGet #

toConstr :: ProjectsDatabasesDocumentsBatchGet -> Constr #

dataTypeOf :: ProjectsDatabasesDocumentsBatchGet -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsDatabasesDocumentsBatchGet) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsDatabasesDocumentsBatchGet) #

gmapT :: (forall b. Data b => b -> b) -> ProjectsDatabasesDocumentsBatchGet -> ProjectsDatabasesDocumentsBatchGet #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesDocumentsBatchGet -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesDocumentsBatchGet -> r #

gmapQ :: (forall d. Data d => d -> u) -> ProjectsDatabasesDocumentsBatchGet -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsDatabasesDocumentsBatchGet -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsDatabasesDocumentsBatchGet -> m ProjectsDatabasesDocumentsBatchGet #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesDocumentsBatchGet -> m ProjectsDatabasesDocumentsBatchGet #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesDocumentsBatchGet -> m ProjectsDatabasesDocumentsBatchGet #

Show ProjectsDatabasesDocumentsBatchGet Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.BatchGet

Methods

showsPrec :: Int -> ProjectsDatabasesDocumentsBatchGet -> ShowS #

show :: ProjectsDatabasesDocumentsBatchGet -> String #

showList :: [ProjectsDatabasesDocumentsBatchGet] -> ShowS #

Generic ProjectsDatabasesDocumentsBatchGet Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.BatchGet

Associated Types

type Rep ProjectsDatabasesDocumentsBatchGet :: Type -> Type #

Methods

from :: ProjectsDatabasesDocumentsBatchGet -> Rep ProjectsDatabasesDocumentsBatchGet x #

to :: Rep ProjectsDatabasesDocumentsBatchGet x -> ProjectsDatabasesDocumentsBatchGet #

GoogleRequest ProjectsDatabasesDocumentsBatchGet Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.BatchGet

Associated Types

type Rs ProjectsDatabasesDocumentsBatchGet :: Type #

type Scopes ProjectsDatabasesDocumentsBatchGet :: [Symbol] #

Methods

requestClient :: ProjectsDatabasesDocumentsBatchGet -> GClient (Rs ProjectsDatabasesDocumentsBatchGet) #

type Rep ProjectsDatabasesDocumentsBatchGet Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.BatchGet

type Rep ProjectsDatabasesDocumentsBatchGet = D1 (MetaData "ProjectsDatabasesDocumentsBatchGet" "Network.Google.Resource.FireStore.Projects.Databases.Documents.BatchGet" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "ProjectsDatabasesDocumentsBatchGet'" PrefixI True) ((S1 (MetaSel (Just "_pddbgXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_pddbgUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pddbgDatabase") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_pddbgAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pddbgUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_pddbgPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BatchGetDocumentsRequest) :*: S1 (MetaSel (Just "_pddbgCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsDatabasesDocumentsBatchGet Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.BatchGet

type Scopes ProjectsDatabasesDocumentsBatchGet = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/datastore" ': ([] :: [Symbol]))
type Rs ProjectsDatabasesDocumentsBatchGet Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.BatchGet

type Rs ProjectsDatabasesDocumentsBatchGet = BatchGetDocumentsResponse

Request Lenses

pddbgXgafv :: Lens' ProjectsDatabasesDocumentsBatchGet (Maybe Xgafv) Source #

V1 error format.

pddbgUploadProtocol :: Lens' ProjectsDatabasesDocumentsBatchGet (Maybe Text) Source #

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

pddbgDatabase :: Lens' ProjectsDatabasesDocumentsBatchGet Text Source #

The database name. In the format: `projects/{project_id}/databases/{database_id}`.

pddbgAccessToken :: Lens' ProjectsDatabasesDocumentsBatchGet (Maybe Text) Source #

OAuth access token.

pddbgUploadType :: Lens' ProjectsDatabasesDocumentsBatchGet (Maybe Text) Source #

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

pddbgPayload :: Lens' ProjectsDatabasesDocumentsBatchGet BatchGetDocumentsRequest Source #

Multipart request metadata.

pddbgCallback :: Lens' ProjectsDatabasesDocumentsBatchGet (Maybe Text) Source #

JSONP