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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Runs a query.

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

Synopsis

type ProjectsDatabasesDocumentsRunQueryResource = "v1" :> (CaptureMode "parent" "runQuery" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] RunQueryRequest :> Post '[JSON] RunQueryResponse))))))))
projectsDatabasesDocumentsRunQuery :: Text -> RunQueryRequest -> ProjectsDatabasesDocumentsRunQuery
data ProjectsDatabasesDocumentsRunQuery
pddrqParent :: Lens' ProjectsDatabasesDocumentsRunQuery Text
pddrqXgafv :: Lens' ProjectsDatabasesDocumentsRunQuery (Maybe Xgafv)
pddrqUploadProtocol :: Lens' ProjectsDatabasesDocumentsRunQuery (Maybe Text)
pddrqAccessToken :: Lens' ProjectsDatabasesDocumentsRunQuery (Maybe Text)
pddrqUploadType :: Lens' ProjectsDatabasesDocumentsRunQuery (Maybe Text)
pddrqPayload :: Lens' ProjectsDatabasesDocumentsRunQuery RunQueryRequest
pddrqCallback :: Lens' ProjectsDatabasesDocumentsRunQuery (Maybe Text)

REST Resource

type ProjectsDatabasesDocumentsRunQueryResource = "v1" :> (CaptureMode "parent" "runQuery" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] RunQueryRequest :> Post '[JSON] RunQueryResponse)))))))) Source #

A resource alias for firestore.projects.databases.documents.runQuery method which the ProjectsDatabasesDocumentsRunQuery request conforms to.

Creating a Request

projectsDatabasesDocumentsRunQuery Source #

Arguments

:: Text	`pddrqParent`
-> RunQueryRequest	`pddrqPayload`
-> ProjectsDatabasesDocumentsRunQuery

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

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

data ProjectsDatabasesDocumentsRunQuery Source #

Runs a query.

See: projectsDatabasesDocumentsRunQuery smart constructor.

Instances

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

Request Lenses

pddrqParent :: Lens' ProjectsDatabasesDocumentsRunQuery Text Source #

The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

pddrqXgafv :: Lens' ProjectsDatabasesDocumentsRunQuery (Maybe Xgafv) Source #

V1 error format.

pddrqUploadProtocol :: Lens' ProjectsDatabasesDocumentsRunQuery (Maybe Text) Source #

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

pddrqAccessToken :: Lens' ProjectsDatabasesDocumentsRunQuery (Maybe Text) Source #

OAuth access token.

pddrqUploadType :: Lens' ProjectsDatabasesDocumentsRunQuery (Maybe Text) Source #

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

pddrqPayload :: Lens' ProjectsDatabasesDocumentsRunQuery RunQueryRequest Source #

Multipart request metadata.

pddrqCallback :: Lens' ProjectsDatabasesDocumentsRunQuery (Maybe Text) Source #

JSONP