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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Streams batches of document updates and deletes, in order.

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

Synopsis

type ProjectsDatabasesDocumentsWriteResource = "v1" :> (Capture "database" Text :> ("documents:write" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] WriteRequest :> Post '[JSON] WriteResponse)))))))))
projectsDatabasesDocumentsWrite :: Text -> WriteRequest -> ProjectsDatabasesDocumentsWrite
data ProjectsDatabasesDocumentsWrite
pddwXgafv :: Lens' ProjectsDatabasesDocumentsWrite (Maybe Xgafv)
pddwUploadProtocol :: Lens' ProjectsDatabasesDocumentsWrite (Maybe Text)
pddwDatabase :: Lens' ProjectsDatabasesDocumentsWrite Text
pddwAccessToken :: Lens' ProjectsDatabasesDocumentsWrite (Maybe Text)
pddwUploadType :: Lens' ProjectsDatabasesDocumentsWrite (Maybe Text)
pddwPayload :: Lens' ProjectsDatabasesDocumentsWrite WriteRequest
pddwCallback :: Lens' ProjectsDatabasesDocumentsWrite (Maybe Text)

REST Resource

type ProjectsDatabasesDocumentsWriteResource = "v1" :> (Capture "database" Text :> ("documents:write" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] WriteRequest :> Post '[JSON] WriteResponse))))))))) Source #

A resource alias for firestore.projects.databases.documents.write method which the ProjectsDatabasesDocumentsWrite request conforms to.

Creating a Request

projectsDatabasesDocumentsWrite Source #

Arguments

:: Text	`pddwDatabase`
-> WriteRequest	`pddwPayload`
-> ProjectsDatabasesDocumentsWrite

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

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

data ProjectsDatabasesDocumentsWrite Source #

Streams batches of document updates and deletes, in order.

See: projectsDatabasesDocumentsWrite smart constructor.

Instances

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

Request Lenses

pddwXgafv :: Lens' ProjectsDatabasesDocumentsWrite (Maybe Xgafv) Source #

V1 error format.

pddwUploadProtocol :: Lens' ProjectsDatabasesDocumentsWrite (Maybe Text) Source #

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

pddwDatabase :: Lens' ProjectsDatabasesDocumentsWrite Text Source #

The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message.

pddwAccessToken :: Lens' ProjectsDatabasesDocumentsWrite (Maybe Text) Source #

OAuth access token.

pddwUploadType :: Lens' ProjectsDatabasesDocumentsWrite (Maybe Text) Source #

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

pddwPayload :: Lens' ProjectsDatabasesDocumentsWrite WriteRequest Source #

Multipart request metadata.

pddwCallback :: Lens' ProjectsDatabasesDocumentsWrite (Maybe Text) Source #

JSONP