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

Gets a single document.

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

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))))))))))

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

Creating a Request

projectsDatabasesDocumentsGet

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:

• pddgXgafv
• pddgReadTime
• pddgUploadProtocol
• pddgAccessToken
• pddgUploadType
• pddgTransaction
• pddgName
• pddgMaskFieldPaths
• pddgCallback

data ProjectsDatabasesDocumentsGet

Gets a single document.

See: projectsDatabasesDocumentsGet smart constructor.

Instances

Eq ProjectsDatabasesDocumentsGet

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

Methods

(==) :: ProjectsDatabasesDocumentsGet -> ProjectsDatabasesDocumentsGet -> Bool

(/=) :: ProjectsDatabasesDocumentsGet -> ProjectsDatabasesDocumentsGet -> Bool

Data ProjectsDatabasesDocumentsGet

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

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

Methods

showsPrec :: Int -> ProjectsDatabasesDocumentsGet -> ShowS

show :: ProjectsDatabasesDocumentsGet -> String

showList :: [ProjectsDatabasesDocumentsGet] -> ShowS

Generic ProjectsDatabasesDocumentsGet

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

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

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

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

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

type Rs ProjectsDatabasesDocumentsGet = Document

Request Lenses

pddgXgafv :: Lens' ProjectsDatabasesDocumentsGet (Maybe Xgafv)

V1 error format.

pddgReadTime :: Lens' ProjectsDatabasesDocumentsGet (Maybe UTCTime)

Reads the version of the document at the given time. This may not be older than 60 seconds.

pddgUploadProtocol :: Lens' ProjectsDatabasesDocumentsGet (Maybe Text)

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

pddgAccessToken :: Lens' ProjectsDatabasesDocumentsGet (Maybe Text)

OAuth access token.

pddgUploadType :: Lens' ProjectsDatabasesDocumentsGet (Maybe Text)

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

pddgTransaction :: Lens' ProjectsDatabasesDocumentsGet (Maybe ByteString)

Reads the document in a transaction.

pddgName :: Lens' ProjectsDatabasesDocumentsGet Text

The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

pddgMaskFieldPaths :: Lens' ProjectsDatabasesDocumentsGet [Text]

The list of field paths in the mask. See Document.fields for a field path syntax reference.

pddgCallback :: Lens' ProjectsDatabasesDocumentsGet (Maybe Text)

JSONP