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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Commits a transaction, while optionally updating documents.

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

Synopsis

type ProjectsDatabasesDocumentsCommitResource = "v1" :> (Capture "database" Text :> ("documents:commit" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] CommitRequest :> Post '[JSON] CommitResponse)))))))))
projectsDatabasesDocumentsCommit :: Text -> CommitRequest -> ProjectsDatabasesDocumentsCommit
data ProjectsDatabasesDocumentsCommit
pddcXgafv :: Lens' ProjectsDatabasesDocumentsCommit (Maybe Xgafv)
pddcUploadProtocol :: Lens' ProjectsDatabasesDocumentsCommit (Maybe Text)
pddcDatabase :: Lens' ProjectsDatabasesDocumentsCommit Text
pddcAccessToken :: Lens' ProjectsDatabasesDocumentsCommit (Maybe Text)
pddcUploadType :: Lens' ProjectsDatabasesDocumentsCommit (Maybe Text)
pddcPayload :: Lens' ProjectsDatabasesDocumentsCommit CommitRequest
pddcCallback :: Lens' ProjectsDatabasesDocumentsCommit (Maybe Text)

REST Resource

type ProjectsDatabasesDocumentsCommitResource = "v1" :> (Capture "database" Text :> ("documents:commit" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] CommitRequest :> Post '[JSON] CommitResponse))))))))) Source #

A resource alias for firestore.projects.databases.documents.commit method which the ProjectsDatabasesDocumentsCommit request conforms to.

Creating a Request

projectsDatabasesDocumentsCommit Source #

Arguments

:: Text	`pddcDatabase`
-> CommitRequest	`pddcPayload`
-> ProjectsDatabasesDocumentsCommit

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

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

data ProjectsDatabasesDocumentsCommit Source #

Commits a transaction, while optionally updating documents.

See: projectsDatabasesDocumentsCommit smart constructor.

Instances

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

Request Lenses

pddcXgafv :: Lens' ProjectsDatabasesDocumentsCommit (Maybe Xgafv) Source #

V1 error format.

pddcUploadProtocol :: Lens' ProjectsDatabasesDocumentsCommit (Maybe Text) Source #

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

pddcDatabase :: Lens' ProjectsDatabasesDocumentsCommit Text Source #

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

pddcAccessToken :: Lens' ProjectsDatabasesDocumentsCommit (Maybe Text) Source #

OAuth access token.

pddcUploadType :: Lens' ProjectsDatabasesDocumentsCommit (Maybe Text) Source #

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

pddcPayload :: Lens' ProjectsDatabasesDocumentsCommit CommitRequest Source #

Multipart request metadata.

pddcCallback :: Lens' ProjectsDatabasesDocumentsCommit (Maybe Text) Source #

JSONP