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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Gets a single document.

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

Synopsis

type ProjectsDatabasesDocumentsGetResource = "v1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "readTime" DateTime' :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "transaction" Bytes :> (QueryParams "mask.fieldPaths" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Document))))))))))
projectsDatabasesDocumentsGet :: Text -> ProjectsDatabasesDocumentsGet
data ProjectsDatabasesDocumentsGet
pddgXgafv :: Lens' ProjectsDatabasesDocumentsGet (Maybe Xgafv)
pddgReadTime :: Lens' ProjectsDatabasesDocumentsGet (Maybe UTCTime)
pddgUploadProtocol :: Lens' ProjectsDatabasesDocumentsGet (Maybe Text)
pddgAccessToken :: Lens' ProjectsDatabasesDocumentsGet (Maybe Text)
pddgUploadType :: Lens' ProjectsDatabasesDocumentsGet (Maybe Text)
pddgTransaction :: Lens' ProjectsDatabasesDocumentsGet (Maybe ByteString)
pddgName :: Lens' ProjectsDatabasesDocumentsGet Text
pddgMaskFieldPaths :: Lens' ProjectsDatabasesDocumentsGet [Text]
pddgCallback :: Lens' ProjectsDatabasesDocumentsGet (Maybe Text)

REST Resource

type ProjectsDatabasesDocumentsGetResource = "v1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "readTime" DateTime' :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "transaction" Bytes :> (QueryParams "mask.fieldPaths" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Document)))))))))) Source #

A resource alias for firestore.projects.databases.documents.get method which the ProjectsDatabasesDocumentsGet request conforms to.

Creating a Request

projectsDatabasesDocumentsGet Source #

Arguments

:: Text	`pddgName`
-> ProjectsDatabasesDocumentsGet

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

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

data ProjectsDatabasesDocumentsGet Source #

Gets a single document.

See: projectsDatabasesDocumentsGet smart constructor.

Instances

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