Network.Google.Resource.FireStore.Projects.Databases.ImportDocuments

Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.

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

REST Resource

type ProjectsDatabasesImportDocumentsResource = "v1" :> (CaptureMode "name" "importDocuments" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleFirestoreAdminV1ImportDocumentsRequest :> Post '[JSON] GoogleLongrunningOperation))))))))

A resource alias for firestore.projects.databases.importDocuments method which the ProjectsDatabasesImportDocuments request conforms to.

Creating a Request

projectsDatabasesImportDocuments

Arguments

:: GoogleFirestoreAdminV1ImportDocumentsRequest

pdidPayload

-> Text

pdidName

-> ProjectsDatabasesImportDocuments

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

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

• pdidXgafv
• pdidUploadProtocol
• pdidAccessToken
• pdidUploadType
• pdidPayload
• pdidName
• pdidCallback

data ProjectsDatabasesImportDocuments

Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.

See: projectsDatabasesImportDocuments smart constructor.

Instances

Eq ProjectsDatabasesImportDocuments

Defined in Network.Google.Resource.FireStore.Projects.Databases.ImportDocuments

Methods

(==) :: ProjectsDatabasesImportDocuments -> ProjectsDatabasesImportDocuments -> Bool

(/=) :: ProjectsDatabasesImportDocuments -> ProjectsDatabasesImportDocuments -> Bool

Data ProjectsDatabasesImportDocuments

Defined in Network.Google.Resource.FireStore.Projects.Databases.ImportDocuments

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsDatabasesImportDocuments -> c ProjectsDatabasesImportDocuments

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsDatabasesImportDocuments

toConstr :: ProjectsDatabasesImportDocuments -> Constr

dataTypeOf :: ProjectsDatabasesImportDocuments -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsDatabasesImportDocuments)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsDatabasesImportDocuments)

gmapT :: (forall b. Data b => b -> b) -> ProjectsDatabasesImportDocuments -> ProjectsDatabasesImportDocuments

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesImportDocuments -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesImportDocuments -> r

gmapQ :: (forall d. Data d => d -> u) -> ProjectsDatabasesImportDocuments -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsDatabasesImportDocuments -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsDatabasesImportDocuments -> m ProjectsDatabasesImportDocuments

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesImportDocuments -> m ProjectsDatabasesImportDocuments

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesImportDocuments -> m ProjectsDatabasesImportDocuments

Show ProjectsDatabasesImportDocuments

Defined in Network.Google.Resource.FireStore.Projects.Databases.ImportDocuments

Methods

showsPrec :: Int -> ProjectsDatabasesImportDocuments -> ShowS

show :: ProjectsDatabasesImportDocuments -> String

showList :: [ProjectsDatabasesImportDocuments] -> ShowS

Generic ProjectsDatabasesImportDocuments

Defined in Network.Google.Resource.FireStore.Projects.Databases.ImportDocuments

Associated Types

type Rep ProjectsDatabasesImportDocuments :: Type -> Type

Methods

from :: ProjectsDatabasesImportDocuments -> Rep ProjectsDatabasesImportDocuments x

to :: Rep ProjectsDatabasesImportDocuments x -> ProjectsDatabasesImportDocuments

GoogleRequest ProjectsDatabasesImportDocuments

Defined in Network.Google.Resource.FireStore.Projects.Databases.ImportDocuments

Associated Types

type Rs ProjectsDatabasesImportDocuments :: Type

type Scopes ProjectsDatabasesImportDocuments :: [Symbol]

Methods

requestClient :: ProjectsDatabasesImportDocuments -> GClient (Rs ProjectsDatabasesImportDocuments)

type Rep ProjectsDatabasesImportDocuments

Defined in Network.Google.Resource.FireStore.Projects.Databases.ImportDocuments

type Rep ProjectsDatabasesImportDocuments = D1 (MetaData "ProjectsDatabasesImportDocuments" "Network.Google.Resource.FireStore.Projects.Databases.ImportDocuments" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "ProjectsDatabasesImportDocuments'" PrefixI True) ((S1 (MetaSel (Just "_pdidXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_pdidUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pdidAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_pdidUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pdidPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 GoogleFirestoreAdminV1ImportDocumentsRequest)) :*: (S1 (MetaSel (Just "_pdidName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pdidCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes ProjectsDatabasesImportDocuments

Defined in Network.Google.Resource.FireStore.Projects.Databases.ImportDocuments

type Scopes ProjectsDatabasesImportDocuments = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/datastore" ': ([] :: [Symbol]))

type Rs ProjectsDatabasesImportDocuments

Defined in Network.Google.Resource.FireStore.Projects.Databases.ImportDocuments

type Rs ProjectsDatabasesImportDocuments = GoogleLongrunningOperation

Request Lenses

pdidXgafv :: Lens' ProjectsDatabasesImportDocuments (Maybe Xgafv)

V1 error format.

pdidUploadProtocol :: Lens' ProjectsDatabasesImportDocuments (Maybe Text)

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

pdidAccessToken :: Lens' ProjectsDatabasesImportDocuments (Maybe Text)

OAuth access token.

pdidUploadType :: Lens' ProjectsDatabasesImportDocuments (Maybe Text)

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

pdidPayload :: Lens' ProjectsDatabasesImportDocuments GoogleFirestoreAdminV1ImportDocumentsRequest

Multipart request metadata.

pdidName :: Lens' ProjectsDatabasesImportDocuments Text

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

pdidCallback :: Lens' ProjectsDatabasesImportDocuments (Maybe Text)

JSONP