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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.

See: Cloud Firestore API Reference for firestore.projects.databases.exportDocuments.

Synopsis

type ProjectsDatabasesExportDocumentsResource = "v1" :> (CaptureMode "name" "exportDocuments" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleFirestoreAdminV1ExportDocumentsRequest :> Post '[JSON] GoogleLongrunningOperation))))))))
projectsDatabasesExportDocuments :: GoogleFirestoreAdminV1ExportDocumentsRequest -> Text -> ProjectsDatabasesExportDocuments
data ProjectsDatabasesExportDocuments
pdedXgafv :: Lens' ProjectsDatabasesExportDocuments (Maybe Xgafv)
pdedUploadProtocol :: Lens' ProjectsDatabasesExportDocuments (Maybe Text)
pdedAccessToken :: Lens' ProjectsDatabasesExportDocuments (Maybe Text)
pdedUploadType :: Lens' ProjectsDatabasesExportDocuments (Maybe Text)
pdedPayload :: Lens' ProjectsDatabasesExportDocuments GoogleFirestoreAdminV1ExportDocumentsRequest
pdedName :: Lens' ProjectsDatabasesExportDocuments Text
pdedCallback :: Lens' ProjectsDatabasesExportDocuments (Maybe Text)

REST Resource

type ProjectsDatabasesExportDocumentsResource = "v1" :> (CaptureMode "name" "exportDocuments" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleFirestoreAdminV1ExportDocumentsRequest :> Post '[JSON] GoogleLongrunningOperation)))))))) Source #

A resource alias for firestore.projects.databases.exportDocuments method which the ProjectsDatabasesExportDocuments request conforms to.

Creating a Request

projectsDatabasesExportDocuments Source #

Arguments

:: GoogleFirestoreAdminV1ExportDocumentsRequest	`pdedPayload`
-> Text	`pdedName`
-> ProjectsDatabasesExportDocuments

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

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

data ProjectsDatabasesExportDocuments Source #

Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.

See: projectsDatabasesExportDocuments smart constructor.

Instances

Eq ProjectsDatabasesExportDocuments Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.ExportDocuments Methods (==) :: ProjectsDatabasesExportDocuments -> ProjectsDatabasesExportDocuments -> Bool # (/=) :: ProjectsDatabasesExportDocuments -> ProjectsDatabasesExportDocuments -> Bool #
Data ProjectsDatabasesExportDocuments Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.ExportDocuments Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsDatabasesExportDocuments -> c ProjectsDatabasesExportDocuments # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsDatabasesExportDocuments # toConstr :: ProjectsDatabasesExportDocuments -> Constr # dataTypeOf :: ProjectsDatabasesExportDocuments -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsDatabasesExportDocuments) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsDatabasesExportDocuments) # gmapT :: (forall b. Data b => b -> b) -> ProjectsDatabasesExportDocuments -> ProjectsDatabasesExportDocuments # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesExportDocuments -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesExportDocuments -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsDatabasesExportDocuments -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsDatabasesExportDocuments -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsDatabasesExportDocuments -> m ProjectsDatabasesExportDocuments # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesExportDocuments -> m ProjectsDatabasesExportDocuments # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesExportDocuments -> m ProjectsDatabasesExportDocuments #
Show ProjectsDatabasesExportDocuments Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.ExportDocuments Methods showsPrec :: Int -> ProjectsDatabasesExportDocuments -> ShowS # show :: ProjectsDatabasesExportDocuments -> String # showList :: [ProjectsDatabasesExportDocuments] -> ShowS #
Generic ProjectsDatabasesExportDocuments Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.ExportDocuments Associated Types type Rep ProjectsDatabasesExportDocuments :: Type -> Type # Methods from :: ProjectsDatabasesExportDocuments -> Rep ProjectsDatabasesExportDocuments x # to :: Rep ProjectsDatabasesExportDocuments x -> ProjectsDatabasesExportDocuments #
GoogleRequest ProjectsDatabasesExportDocuments Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.ExportDocuments Associated Types type Rs ProjectsDatabasesExportDocuments :: Type # type Scopes ProjectsDatabasesExportDocuments :: [Symbol] # Methods requestClient :: ProjectsDatabasesExportDocuments -> GClient (Rs ProjectsDatabasesExportDocuments) #
type Rep ProjectsDatabasesExportDocuments Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.ExportDocuments type Rep ProjectsDatabasesExportDocuments = D1 (MetaData "ProjectsDatabasesExportDocuments" "Network.Google.Resource.FireStore.Projects.Databases.ExportDocuments" "gogol-firestore-0.5.0-7rr7qtRkAClEQRp7SbCbFR" False) (C1 (MetaCons "ProjectsDatabasesExportDocuments'" PrefixI True) ((S1 (MetaSel (Just "_pdedXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_pdedUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pdedAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_pdedUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pdedPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 GoogleFirestoreAdminV1ExportDocumentsRequest)) :: (S1 (MetaSel (Just "_pdedName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_pdedCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsDatabasesExportDocuments Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.ExportDocuments type Scopes ProjectsDatabasesExportDocuments = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/datastore" ': ([] :: [Symbol]))
type Rs ProjectsDatabasesExportDocuments Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.ExportDocuments type Rs ProjectsDatabasesExportDocuments = GoogleLongrunningOperation

Request Lenses

pdedXgafv :: Lens' ProjectsDatabasesExportDocuments (Maybe Xgafv) Source #

V1 error format.

pdedUploadProtocol :: Lens' ProjectsDatabasesExportDocuments (Maybe Text) Source #

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

pdedAccessToken :: Lens' ProjectsDatabasesExportDocuments (Maybe Text) Source #

OAuth access token.

pdedUploadType :: Lens' ProjectsDatabasesExportDocuments (Maybe Text) Source #

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

pdedPayload :: Lens' ProjectsDatabasesExportDocuments GoogleFirestoreAdminV1ExportDocumentsRequest Source #

Multipart request metadata.

pdedName :: Lens' ProjectsDatabasesExportDocuments Text Source #

Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`.

pdedCallback :: Lens' ProjectsDatabasesExportDocuments (Maybe Text) Source #

JSONP