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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Starts a new transaction.

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

Synopsis

type ProjectsDatabasesDocumentsBeginTransactionResource = "v1" :> (Capture "database" Text :> ("documents:beginTransaction" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] BeginTransactionRequest :> Post '[JSON] BeginTransactionResponse)))))))))
projectsDatabasesDocumentsBeginTransaction :: Text -> BeginTransactionRequest -> ProjectsDatabasesDocumentsBeginTransaction
data ProjectsDatabasesDocumentsBeginTransaction
pddbtXgafv :: Lens' ProjectsDatabasesDocumentsBeginTransaction (Maybe Xgafv)
pddbtUploadProtocol :: Lens' ProjectsDatabasesDocumentsBeginTransaction (Maybe Text)
pddbtDatabase :: Lens' ProjectsDatabasesDocumentsBeginTransaction Text
pddbtAccessToken :: Lens' ProjectsDatabasesDocumentsBeginTransaction (Maybe Text)
pddbtUploadType :: Lens' ProjectsDatabasesDocumentsBeginTransaction (Maybe Text)
pddbtPayload :: Lens' ProjectsDatabasesDocumentsBeginTransaction BeginTransactionRequest
pddbtCallback :: Lens' ProjectsDatabasesDocumentsBeginTransaction (Maybe Text)

REST Resource

type ProjectsDatabasesDocumentsBeginTransactionResource = "v1" :> (Capture "database" Text :> ("documents:beginTransaction" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] BeginTransactionRequest :> Post '[JSON] BeginTransactionResponse))))))))) Source #

A resource alias for firestore.projects.databases.documents.beginTransaction method which the ProjectsDatabasesDocumentsBeginTransaction request conforms to.

Creating a Request

projectsDatabasesDocumentsBeginTransaction Source #

Arguments

:: Text	`pddbtDatabase`
-> BeginTransactionRequest	`pddbtPayload`
-> ProjectsDatabasesDocumentsBeginTransaction

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

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

data ProjectsDatabasesDocumentsBeginTransaction Source #

Starts a new transaction.

See: projectsDatabasesDocumentsBeginTransaction smart constructor.

Instances

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

Request Lenses

pddbtXgafv :: Lens' ProjectsDatabasesDocumentsBeginTransaction (Maybe Xgafv) Source #

V1 error format.

pddbtUploadProtocol :: Lens' ProjectsDatabasesDocumentsBeginTransaction (Maybe Text) Source #

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

pddbtDatabase :: Lens' ProjectsDatabasesDocumentsBeginTransaction Text Source #

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

pddbtAccessToken :: Lens' ProjectsDatabasesDocumentsBeginTransaction (Maybe Text) Source #

OAuth access token.

pddbtUploadType :: Lens' ProjectsDatabasesDocumentsBeginTransaction (Maybe Text) Source #

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

pddbtPayload :: Lens' ProjectsDatabasesDocumentsBeginTransaction BeginTransactionRequest Source #

Multipart request metadata.

pddbtCallback :: Lens' ProjectsDatabasesDocumentsBeginTransaction (Maybe Text) Source #

JSONP