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

Contents

Description

Creates a new document.

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

Synopsis

REST Resource

type ProjectsDatabasesDocumentsCreateDocumentResource = "v1" :> (Capture "parent" Text :> (Capture "collectionId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "documentId" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParams "mask.fieldPaths" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Document :> Post '[JSON] Document))))))))))) Source #

A resource alias for firestore.projects.databases.documents.createDocument method which the ProjectsDatabasesDocumentsCreateDocument request conforms to.

Creating a Request

projectsDatabasesDocumentsCreateDocument Source #

Arguments

:: Text

pddcdParent

-> Text

pddcdCollectionId

-> Document

pddcdPayload

-> ProjectsDatabasesDocumentsCreateDocument 

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

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

data ProjectsDatabasesDocumentsCreateDocument Source #

Creates a new document.

See: projectsDatabasesDocumentsCreateDocument smart constructor.

Instances
Eq ProjectsDatabasesDocumentsCreateDocument Source # 
Instance details

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

Methods

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

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

Data ProjectsDatabasesDocumentsCreateDocument Source # 
Instance details

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

Methods

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

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

toConstr :: ProjectsDatabasesDocumentsCreateDocument -> Constr #

dataTypeOf :: ProjectsDatabasesDocumentsCreateDocument -> DataType #

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

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

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

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

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

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

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

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

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

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

Show ProjectsDatabasesDocumentsCreateDocument Source # 
Instance details

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

Methods

showsPrec :: Int -> ProjectsDatabasesDocumentsCreateDocument -> ShowS #

show :: ProjectsDatabasesDocumentsCreateDocument -> String #

showList :: [ProjectsDatabasesDocumentsCreateDocument] -> ShowS #

Generic ProjectsDatabasesDocumentsCreateDocument Source # 
Instance details

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

Associated Types

type Rep ProjectsDatabasesDocumentsCreateDocument :: Type -> Type #

Methods

from :: ProjectsDatabasesDocumentsCreateDocument -> Rep ProjectsDatabasesDocumentsCreateDocument x #

to :: Rep ProjectsDatabasesDocumentsCreateDocument x -> ProjectsDatabasesDocumentsCreateDocument #

GoogleRequest ProjectsDatabasesDocumentsCreateDocument Source # 
Instance details

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

Associated Types

type Rs ProjectsDatabasesDocumentsCreateDocument :: Type #

type Scopes ProjectsDatabasesDocumentsCreateDocument :: [Symbol] #

Methods

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

type Rep ProjectsDatabasesDocumentsCreateDocument Source # 
Instance details

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

type Rep ProjectsDatabasesDocumentsCreateDocument = D1 (MetaData "ProjectsDatabasesDocumentsCreateDocument" "Network.Google.Resource.FireStore.Projects.Databases.Documents.CreateDocument" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "ProjectsDatabasesDocumentsCreateDocument'" PrefixI True) (((S1 (MetaSel (Just "_pddcdParent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pddcdXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) :*: (S1 (MetaSel (Just "_pddcdDocumentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pddcdUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pddcdAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_pddcdCollectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pddcdUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_pddcdPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Document) :*: (S1 (MetaSel (Just "_pddcdMaskFieldPaths") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_pddcdCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes ProjectsDatabasesDocumentsCreateDocument Source # 
Instance details

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

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

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

type Rs ProjectsDatabasesDocumentsCreateDocument = Document

Request Lenses

pddcdParent :: Lens' ProjectsDatabasesDocumentsCreateDocument Text Source #

The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`

pddcdXgafv :: Lens' ProjectsDatabasesDocumentsCreateDocument (Maybe Xgafv) Source #

V1 error format.

pddcdDocumentId :: Lens' ProjectsDatabasesDocumentsCreateDocument (Maybe Text) Source #

The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.

pddcdUploadProtocol :: Lens' ProjectsDatabasesDocumentsCreateDocument (Maybe Text) Source #

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

pddcdAccessToken :: Lens' ProjectsDatabasesDocumentsCreateDocument (Maybe Text) Source #

OAuth access token.

pddcdCollectionId :: Lens' ProjectsDatabasesDocumentsCreateDocument Text Source #

The collection ID, relative to `parent`, to list. For example: `chatrooms`.

pddcdUploadType :: Lens' ProjectsDatabasesDocumentsCreateDocument (Maybe Text) Source #

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

pddcdPayload :: Lens' ProjectsDatabasesDocumentsCreateDocument Document Source #

Multipart request metadata.

pddcdMaskFieldPaths :: Lens' ProjectsDatabasesDocumentsCreateDocument [Text] Source #

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

pddcdCallback :: Lens' ProjectsDatabasesDocumentsCreateDocument (Maybe Text) Source #

JSONP