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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Listens to changes.

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

Synopsis

type ProjectsDatabasesDocumentsListenResource = "v1" :> (Capture "database" Text :> ("documents:listen" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ListenRequest :> Post '[JSON] ListenResponse)))))))))
projectsDatabasesDocumentsListen :: Text -> ListenRequest -> ProjectsDatabasesDocumentsListen
data ProjectsDatabasesDocumentsListen
pddlXgafv :: Lens' ProjectsDatabasesDocumentsListen (Maybe Xgafv)
pddlUploadProtocol :: Lens' ProjectsDatabasesDocumentsListen (Maybe Text)
pddlDatabase :: Lens' ProjectsDatabasesDocumentsListen Text
pddlAccessToken :: Lens' ProjectsDatabasesDocumentsListen (Maybe Text)
pddlUploadType :: Lens' ProjectsDatabasesDocumentsListen (Maybe Text)
pddlPayload :: Lens' ProjectsDatabasesDocumentsListen ListenRequest
pddlCallback :: Lens' ProjectsDatabasesDocumentsListen (Maybe Text)

REST Resource

type ProjectsDatabasesDocumentsListenResource = "v1" :> (Capture "database" Text :> ("documents:listen" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ListenRequest :> Post '[JSON] ListenResponse))))))))) Source #

A resource alias for firestore.projects.databases.documents.listen method which the ProjectsDatabasesDocumentsListen request conforms to.

Creating a Request

projectsDatabasesDocumentsListen Source #

Arguments

:: Text	`pddlDatabase`
-> ListenRequest	`pddlPayload`
-> ProjectsDatabasesDocumentsListen

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

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

data ProjectsDatabasesDocumentsListen Source #

Listens to changes.

See: projectsDatabasesDocumentsListen smart constructor.

Instances

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

Request Lenses

pddlXgafv :: Lens' ProjectsDatabasesDocumentsListen (Maybe Xgafv) Source #

V1 error format.

pddlUploadProtocol :: Lens' ProjectsDatabasesDocumentsListen (Maybe Text) Source #

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

pddlDatabase :: Lens' ProjectsDatabasesDocumentsListen Text Source #

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

pddlAccessToken :: Lens' ProjectsDatabasesDocumentsListen (Maybe Text) Source #

OAuth access token.

pddlUploadType :: Lens' ProjectsDatabasesDocumentsListen (Maybe Text) Source #

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

pddlPayload :: Lens' ProjectsDatabasesDocumentsListen ListenRequest Source #

Multipart request metadata.

pddlCallback :: Lens' ProjectsDatabasesDocumentsListen (Maybe Text) Source #

JSONP