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 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- firestore.projects.databases.collectionGroups.fields.get
- firestore.projects.databases.collectionGroups.fields.list
- firestore.projects.databases.collectionGroups.fields.patch
- firestore.projects.databases.collectionGroups.indexes.create
- firestore.projects.databases.collectionGroups.indexes.delete
- firestore.projects.databases.collectionGroups.indexes.get
- firestore.projects.databases.collectionGroups.indexes.list
- firestore.projects.databases.documents.batchGet
- firestore.projects.databases.documents.beginTransaction
- firestore.projects.databases.documents.commit
- firestore.projects.databases.documents.createDocument
- firestore.projects.databases.documents.delete
- firestore.projects.databases.documents.get
- firestore.projects.databases.documents.list
- firestore.projects.databases.documents.listCollectionIds
- firestore.projects.databases.documents.listen
- firestore.projects.databases.documents.patch
- firestore.projects.databases.documents.rollback
- firestore.projects.databases.documents.runQuery
- firestore.projects.databases.documents.write
- firestore.projects.databases.exportDocuments
- firestore.projects.databases.importDocuments
- firestore.projects.databases.operations.cancel
- firestore.projects.databases.operations.delete
- firestore.projects.databases.operations.get
- firestore.projects.databases.operations.list
- firestore.projects.locations.get
- firestore.projects.locations.list
- Types
- WriteRequest
- LatLng
- GoogleFirestoreAdminV1IndexFieldOrder
- WriteResult
- GoogleFirestoreAdminV1Field
- TransactionOptions
- GoogleFirestoreAdminV1IndexConfigDeltaChangeType
- Status
- GoogleLongrunningOperationMetadata
- Precondition
- ReadWrite
- RollbackRequest
- GoogleFirestoreAdminV1ExportDocumentsRequest
- TargetChange
- ListLocationsResponse
- GoogleFirestoreAdminV1IndexState
- CompositeFilterOp
- Cursor
- GoogleFirestoreAdminV1ImportDocumentsMetadata
- BeginTransactionRequest
- RunQueryRequest
- GoogleFirestoreAdminV1IndexConfigDelta
- GoogleFirestoreAdminV1IndexConfig
- GoogleFirestoreAdminV1IndexField
- Write
- Location
- Empty
- BatchGetDocumentsResponse
- CompositeFilter
- DocumentsTarget
- ListenRequestLabels
- GoogleFirestoreAdminV1Index
- BeginTransactionResponse
- RunQueryResponse
- GoogleFirestoreAdminV1IndexQueryScope
- GoogleFirestoreAdminV1ExportDocumentsMetadata
- GoogleFirestoreAdminV1Progress
- DocumentMask
- QueryTarget
- Value
- OrderDirection
- ValueNullValue
- StatusDetailsItem
- DocumentTransform
- StructuredQuery
- ExistenceFilter
- GoogleFirestoreAdminV1ListFieldsResponse
- GoogleFirestoreAdminV1ImportDocumentsRequest
- GoogleFirestoreAdminV1LocationMetadata
- GoogleLongrunningCancelOperationRequest
- UnaryFilterOp
- ListCollectionIdsResponse
- FieldReference
- DocumentRemove
- GoogleFirestoreAdminV1IndexFieldArrayConfig
- DocumentChange
- GoogleFirestoreAdminV1FieldOperationMetadata
- GoogleFirestoreAdminV1ListIndexesResponse
- MapValue
- BatchGetDocumentsRequest
- Document
- GoogleFirestoreAdminV1IndexOperationMetadataState
- ArrayValue
- Xgafv
- CommitResponse
- ListenResponse
- FieldFilter
- GoogleLongrunningOperationResponse
- ListDocumentsResponse
- GoogleFirestoreAdminV1ExportDocumentsResponse
- FieldFilterOp
- Projection
- Filter
- TargetChangeTargetChangeType
- GoogleFirestoreAdminV1IndexOperationMetadata
- LocationLabels
- ListenRequest
- GoogleFirestoreAdminV1ImportDocumentsMetadataOperationState
- CommitRequest
- LocationMetadata
- GoogleLongrunningListOperationsResponse
- GoogleFirestoreAdminV1FieldOperationMetadataState
- CollectionSelector
- ListCollectionIdsRequest
- WriteResponse
- Order
- DocumentDelete
- FieldTransform
- MapValueFields
- DocumentFields
- ReadOnly
- Target
- WriteRequestLabels
- FieldTransformSetToServerValue
- GoogleLongrunningOperation
- GoogleFirestoreAdminV1ExportDocumentsMetadataOperationState
- UnaryFilter
Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
Synopsis
- fireStoreService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- datastoreScope :: Proxy '["https://www.googleapis.com/auth/datastore"]
- type FireStoreAPI = ProjectsLocationsListResource :<|> (ProjectsLocationsGetResource :<|> (ProjectsDatabasesDocumentsListCollectionIdsResource :<|> (ProjectsDatabasesDocumentsListResource :<|> (ProjectsDatabasesDocumentsWriteResource :<|> (ProjectsDatabasesDocumentsCreateDocumentResource :<|> (ProjectsDatabasesDocumentsBeginTransactionResource :<|> (ProjectsDatabasesDocumentsRunQueryResource :<|> (ProjectsDatabasesDocumentsPatchResource :<|> (ProjectsDatabasesDocumentsGetResource :<|> (ProjectsDatabasesDocumentsRollbackResource :<|> (ProjectsDatabasesDocumentsBatchGetResource :<|> (ProjectsDatabasesDocumentsDeleteResource :<|> (ProjectsDatabasesDocumentsListenResource :<|> (ProjectsDatabasesDocumentsCommitResource :<|> (ProjectsDatabasesCollectionGroupsIndexesListResource :<|> (ProjectsDatabasesCollectionGroupsIndexesGetResource :<|> (ProjectsDatabasesCollectionGroupsIndexesCreateResource :<|> (ProjectsDatabasesCollectionGroupsIndexesDeleteResource :<|> (ProjectsDatabasesCollectionGroupsFieldsListResource :<|> (ProjectsDatabasesCollectionGroupsFieldsPatchResource :<|> (ProjectsDatabasesCollectionGroupsFieldsGetResource :<|> (ProjectsDatabasesOperationsListResource :<|> (ProjectsDatabasesOperationsGetResource :<|> (ProjectsDatabasesOperationsCancelResource :<|> (ProjectsDatabasesOperationsDeleteResource :<|> (ProjectsDatabasesExportDocumentsResource :<|> ProjectsDatabasesImportDocumentsResource))))))))))))))))))))))))))
- module Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.Get
- module Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.List
- module Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.Patch
- module Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Indexes.Create
- module Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Indexes.Delete
- module Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Indexes.Get
- module Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Indexes.List
- module Network.Google.Resource.FireStore.Projects.Databases.Documents.BatchGet
- module Network.Google.Resource.FireStore.Projects.Databases.Documents.BeginTransaction
- module Network.Google.Resource.FireStore.Projects.Databases.Documents.Commit
- module Network.Google.Resource.FireStore.Projects.Databases.Documents.CreateDocument
- module Network.Google.Resource.FireStore.Projects.Databases.Documents.Delete
- module Network.Google.Resource.FireStore.Projects.Databases.Documents.Get
- module Network.Google.Resource.FireStore.Projects.Databases.Documents.List
- module Network.Google.Resource.FireStore.Projects.Databases.Documents.ListCollectionIds
- module Network.Google.Resource.FireStore.Projects.Databases.Documents.Listen
- module Network.Google.Resource.FireStore.Projects.Databases.Documents.Patch
- module Network.Google.Resource.FireStore.Projects.Databases.Documents.Rollback
- module Network.Google.Resource.FireStore.Projects.Databases.Documents.RunQuery
- module Network.Google.Resource.FireStore.Projects.Databases.Documents.Write
- module Network.Google.Resource.FireStore.Projects.Databases.ExportDocuments
- module Network.Google.Resource.FireStore.Projects.Databases.ImportDocuments
- module Network.Google.Resource.FireStore.Projects.Databases.Operations.Cancel
- module Network.Google.Resource.FireStore.Projects.Databases.Operations.Delete
- module Network.Google.Resource.FireStore.Projects.Databases.Operations.Get
- module Network.Google.Resource.FireStore.Projects.Databases.Operations.List
- module Network.Google.Resource.FireStore.Projects.Locations.Get
- module Network.Google.Resource.FireStore.Projects.Locations.List
- data WriteRequest
- writeRequest :: WriteRequest
- wrStreamToken :: Lens' WriteRequest (Maybe ByteString)
- wrLabels :: Lens' WriteRequest (Maybe WriteRequestLabels)
- wrWrites :: Lens' WriteRequest [Write]
- wrStreamId :: Lens' WriteRequest (Maybe Text)
- data LatLng
- latLng :: LatLng
- llLatitude :: Lens' LatLng (Maybe Double)
- llLongitude :: Lens' LatLng (Maybe Double)
- data GoogleFirestoreAdminV1IndexFieldOrder
- data WriteResult
- writeResult :: WriteResult
- wrUpdateTime :: Lens' WriteResult (Maybe UTCTime)
- wrTransformResults :: Lens' WriteResult [Value]
- data GoogleFirestoreAdminV1Field
- googleFirestoreAdminV1Field :: GoogleFirestoreAdminV1Field
- gfavfIndexConfig :: Lens' GoogleFirestoreAdminV1Field (Maybe GoogleFirestoreAdminV1IndexConfig)
- gfavfName :: Lens' GoogleFirestoreAdminV1Field (Maybe Text)
- data TransactionOptions
- transactionOptions :: TransactionOptions
- toReadWrite :: Lens' TransactionOptions (Maybe ReadWrite)
- toReadOnly :: Lens' TransactionOptions (Maybe ReadOnly)
- data GoogleFirestoreAdminV1IndexConfigDeltaChangeType
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data GoogleLongrunningOperationMetadata
- googleLongrunningOperationMetadata :: HashMap Text JSONValue -> GoogleLongrunningOperationMetadata
- glomAddtional :: Lens' GoogleLongrunningOperationMetadata (HashMap Text JSONValue)
- data Precondition
- precondition :: Precondition
- pExists :: Lens' Precondition (Maybe Bool)
- pUpdateTime :: Lens' Precondition (Maybe UTCTime)
- data ReadWrite
- readWrite :: ReadWrite
- rwRetryTransaction :: Lens' ReadWrite (Maybe ByteString)
- data RollbackRequest
- rollbackRequest :: RollbackRequest
- rrTransaction :: Lens' RollbackRequest (Maybe ByteString)
- data GoogleFirestoreAdminV1ExportDocumentsRequest
- googleFirestoreAdminV1ExportDocumentsRequest :: GoogleFirestoreAdminV1ExportDocumentsRequest
- gfavedrCollectionIds :: Lens' GoogleFirestoreAdminV1ExportDocumentsRequest [Text]
- gfavedrOutputURIPrefix :: Lens' GoogleFirestoreAdminV1ExportDocumentsRequest (Maybe Text)
- data TargetChange
- targetChange :: TargetChange
- tcReadTime :: Lens' TargetChange (Maybe UTCTime)
- tcResumeToken :: Lens' TargetChange (Maybe ByteString)
- tcCause :: Lens' TargetChange (Maybe Status)
- tcTargetChangeType :: Lens' TargetChange (Maybe TargetChangeTargetChangeType)
- tcTargetIds :: Lens' TargetChange [Int32]
- data ListLocationsResponse
- listLocationsResponse :: ListLocationsResponse
- llrNextPageToken :: Lens' ListLocationsResponse (Maybe Text)
- llrLocations :: Lens' ListLocationsResponse [Location]
- data GoogleFirestoreAdminV1IndexState
- data CompositeFilterOp
- data Cursor
- cursor :: Cursor
- cValues :: Lens' Cursor [Value]
- cBefore :: Lens' Cursor (Maybe Bool)
- data GoogleFirestoreAdminV1ImportDocumentsMetadata
- googleFirestoreAdminV1ImportDocumentsMetadata :: GoogleFirestoreAdminV1ImportDocumentsMetadata
- gfavidmProgressBytes :: Lens' GoogleFirestoreAdminV1ImportDocumentsMetadata (Maybe GoogleFirestoreAdminV1Progress)
- gfavidmStartTime :: Lens' GoogleFirestoreAdminV1ImportDocumentsMetadata (Maybe UTCTime)
- gfavidmInputURIPrefix :: Lens' GoogleFirestoreAdminV1ImportDocumentsMetadata (Maybe Text)
- gfavidmCollectionIds :: Lens' GoogleFirestoreAdminV1ImportDocumentsMetadata [Text]
- gfavidmProgressDocuments :: Lens' GoogleFirestoreAdminV1ImportDocumentsMetadata (Maybe GoogleFirestoreAdminV1Progress)
- gfavidmEndTime :: Lens' GoogleFirestoreAdminV1ImportDocumentsMetadata (Maybe UTCTime)
- gfavidmOperationState :: Lens' GoogleFirestoreAdminV1ImportDocumentsMetadata (Maybe GoogleFirestoreAdminV1ImportDocumentsMetadataOperationState)
- data BeginTransactionRequest
- beginTransactionRequest :: BeginTransactionRequest
- btrOptions :: Lens' BeginTransactionRequest (Maybe TransactionOptions)
- data RunQueryRequest
- runQueryRequest :: RunQueryRequest
- rqrReadTime :: Lens' RunQueryRequest (Maybe UTCTime)
- rqrNewTransaction :: Lens' RunQueryRequest (Maybe TransactionOptions)
- rqrStructuredQuery :: Lens' RunQueryRequest (Maybe StructuredQuery)
- rqrTransaction :: Lens' RunQueryRequest (Maybe ByteString)
- data GoogleFirestoreAdminV1IndexConfigDelta
- googleFirestoreAdminV1IndexConfigDelta :: GoogleFirestoreAdminV1IndexConfigDelta
- gfavicdIndex :: Lens' GoogleFirestoreAdminV1IndexConfigDelta (Maybe GoogleFirestoreAdminV1Index)
- gfavicdChangeType :: Lens' GoogleFirestoreAdminV1IndexConfigDelta (Maybe GoogleFirestoreAdminV1IndexConfigDeltaChangeType)
- data GoogleFirestoreAdminV1IndexConfig
- googleFirestoreAdminV1IndexConfig :: GoogleFirestoreAdminV1IndexConfig
- gfavicAncestorField :: Lens' GoogleFirestoreAdminV1IndexConfig (Maybe Text)
- gfavicReverting :: Lens' GoogleFirestoreAdminV1IndexConfig (Maybe Bool)
- gfavicIndexes :: Lens' GoogleFirestoreAdminV1IndexConfig [GoogleFirestoreAdminV1Index]
- gfavicUsesAncestorConfig :: Lens' GoogleFirestoreAdminV1IndexConfig (Maybe Bool)
- data GoogleFirestoreAdminV1IndexField
- googleFirestoreAdminV1IndexField :: GoogleFirestoreAdminV1IndexField
- gfavifFieldPath :: Lens' GoogleFirestoreAdminV1IndexField (Maybe Text)
- gfavifArrayConfig :: Lens' GoogleFirestoreAdminV1IndexField (Maybe GoogleFirestoreAdminV1IndexFieldArrayConfig)
- gfavifOrder :: Lens' GoogleFirestoreAdminV1IndexField (Maybe GoogleFirestoreAdminV1IndexFieldOrder)
- data Write
- write :: Write
- wTransform :: Lens' Write (Maybe DocumentTransform)
- wUpdateMask :: Lens' Write (Maybe DocumentMask)
- wCurrentDocument :: Lens' Write (Maybe Precondition)
- wDelete :: Lens' Write (Maybe Text)
- wUpdate :: Lens' Write (Maybe Document)
- data Location
- location :: Location
- lName :: Lens' Location (Maybe Text)
- lMetadata :: Lens' Location (Maybe LocationMetadata)
- lDisplayName :: Lens' Location (Maybe Text)
- lLabels :: Lens' Location (Maybe LocationLabels)
- lLocationId :: Lens' Location (Maybe Text)
- data Empty
- empty :: Empty
- data BatchGetDocumentsResponse
- batchGetDocumentsResponse :: BatchGetDocumentsResponse
- bgdrReadTime :: Lens' BatchGetDocumentsResponse (Maybe UTCTime)
- bgdrFound :: Lens' BatchGetDocumentsResponse (Maybe Document)
- bgdrTransaction :: Lens' BatchGetDocumentsResponse (Maybe ByteString)
- bgdrMissing :: Lens' BatchGetDocumentsResponse (Maybe Text)
- data CompositeFilter
- compositeFilter :: CompositeFilter
- cfOp :: Lens' CompositeFilter (Maybe CompositeFilterOp)
- cfFilters :: Lens' CompositeFilter [Filter]
- data DocumentsTarget
- documentsTarget :: DocumentsTarget
- dtDocuments :: Lens' DocumentsTarget [Text]
- data ListenRequestLabels
- listenRequestLabels :: HashMap Text Text -> ListenRequestLabels
- lrlAddtional :: Lens' ListenRequestLabels (HashMap Text Text)
- data GoogleFirestoreAdminV1Index
- googleFirestoreAdminV1Index :: GoogleFirestoreAdminV1Index
- gfaviState :: Lens' GoogleFirestoreAdminV1Index (Maybe GoogleFirestoreAdminV1IndexState)
- gfaviQueryScope :: Lens' GoogleFirestoreAdminV1Index (Maybe GoogleFirestoreAdminV1IndexQueryScope)
- gfaviName :: Lens' GoogleFirestoreAdminV1Index (Maybe Text)
- gfaviFields :: Lens' GoogleFirestoreAdminV1Index [GoogleFirestoreAdminV1IndexField]
- data BeginTransactionResponse
- beginTransactionResponse :: BeginTransactionResponse
- btrTransaction :: Lens' BeginTransactionResponse (Maybe ByteString)
- data RunQueryResponse
- runQueryResponse :: RunQueryResponse
- rReadTime :: Lens' RunQueryResponse (Maybe UTCTime)
- rSkippedResults :: Lens' RunQueryResponse (Maybe Int32)
- rTransaction :: Lens' RunQueryResponse (Maybe ByteString)
- rDocument :: Lens' RunQueryResponse (Maybe Document)
- data GoogleFirestoreAdminV1IndexQueryScope
- data GoogleFirestoreAdminV1ExportDocumentsMetadata
- googleFirestoreAdminV1ExportDocumentsMetadata :: GoogleFirestoreAdminV1ExportDocumentsMetadata
- gfavedmProgressBytes :: Lens' GoogleFirestoreAdminV1ExportDocumentsMetadata (Maybe GoogleFirestoreAdminV1Progress)
- gfavedmStartTime :: Lens' GoogleFirestoreAdminV1ExportDocumentsMetadata (Maybe UTCTime)
- gfavedmCollectionIds :: Lens' GoogleFirestoreAdminV1ExportDocumentsMetadata [Text]
- gfavedmProgressDocuments :: Lens' GoogleFirestoreAdminV1ExportDocumentsMetadata (Maybe GoogleFirestoreAdminV1Progress)
- gfavedmEndTime :: Lens' GoogleFirestoreAdminV1ExportDocumentsMetadata (Maybe UTCTime)
- gfavedmOperationState :: Lens' GoogleFirestoreAdminV1ExportDocumentsMetadata (Maybe GoogleFirestoreAdminV1ExportDocumentsMetadataOperationState)
- gfavedmOutputURIPrefix :: Lens' GoogleFirestoreAdminV1ExportDocumentsMetadata (Maybe Text)
- data GoogleFirestoreAdminV1Progress
- googleFirestoreAdminV1Progress :: GoogleFirestoreAdminV1Progress
- gfavpCompletedWork :: Lens' GoogleFirestoreAdminV1Progress (Maybe Int64)
- gfavpEstimatedWork :: Lens' GoogleFirestoreAdminV1Progress (Maybe Int64)
- data DocumentMask
- documentMask :: DocumentMask
- dmFieldPaths :: Lens' DocumentMask [Text]
- data QueryTarget
- queryTarget :: QueryTarget
- qtParent :: Lens' QueryTarget (Maybe Text)
- qtStructuredQuery :: Lens' QueryTarget (Maybe StructuredQuery)
- data Value
- value :: Value
- vGeoPointValue :: Lens' Value (Maybe LatLng)
- vBytesValue :: Lens' Value (Maybe ByteString)
- vIntegerValue :: Lens' Value (Maybe Int64)
- vTimestampValue :: Lens' Value (Maybe UTCTime)
- vDoubleValue :: Lens' Value (Maybe Double)
- vStringValue :: Lens' Value (Maybe Text)
- vBooleanValue :: Lens' Value (Maybe Bool)
- vMapValue :: Lens' Value (Maybe MapValue)
- vArrayValue :: Lens' Value (Maybe ArrayValue)
- vReferenceValue :: Lens' Value (Maybe Text)
- vNullValue :: Lens' Value (Maybe ValueNullValue)
- data OrderDirection
- data ValueNullValue = NullValue
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data DocumentTransform
- documentTransform :: DocumentTransform
- dtDocument :: Lens' DocumentTransform (Maybe Text)
- dtFieldTransforms :: Lens' DocumentTransform [FieldTransform]
- data StructuredQuery
- structuredQuery :: StructuredQuery
- sqWhere :: Lens' StructuredQuery (Maybe Filter)
- sqOrderBy :: Lens' StructuredQuery [Order]
- sqStartAt :: Lens' StructuredQuery (Maybe Cursor)
- sqOffSet :: Lens' StructuredQuery (Maybe Int32)
- sqFrom :: Lens' StructuredQuery [CollectionSelector]
- sqEndAt :: Lens' StructuredQuery (Maybe Cursor)
- sqLimit :: Lens' StructuredQuery (Maybe Int32)
- sqSelect :: Lens' StructuredQuery (Maybe Projection)
- data ExistenceFilter
- existenceFilter :: ExistenceFilter
- efTargetId :: Lens' ExistenceFilter (Maybe Int32)
- efCount :: Lens' ExistenceFilter (Maybe Int32)
- data GoogleFirestoreAdminV1ListFieldsResponse
- googleFirestoreAdminV1ListFieldsResponse :: GoogleFirestoreAdminV1ListFieldsResponse
- gfavlfrNextPageToken :: Lens' GoogleFirestoreAdminV1ListFieldsResponse (Maybe Text)
- gfavlfrFields :: Lens' GoogleFirestoreAdminV1ListFieldsResponse [GoogleFirestoreAdminV1Field]
- data GoogleFirestoreAdminV1ImportDocumentsRequest
- googleFirestoreAdminV1ImportDocumentsRequest :: GoogleFirestoreAdminV1ImportDocumentsRequest
- gfavidrInputURIPrefix :: Lens' GoogleFirestoreAdminV1ImportDocumentsRequest (Maybe Text)
- gfavidrCollectionIds :: Lens' GoogleFirestoreAdminV1ImportDocumentsRequest [Text]
- data GoogleFirestoreAdminV1LocationMetadata
- googleFirestoreAdminV1LocationMetadata :: GoogleFirestoreAdminV1LocationMetadata
- data GoogleLongrunningCancelOperationRequest
- googleLongrunningCancelOperationRequest :: GoogleLongrunningCancelOperationRequest
- data UnaryFilterOp
- data ListCollectionIdsResponse
- listCollectionIdsResponse :: ListCollectionIdsResponse
- lcirNextPageToken :: Lens' ListCollectionIdsResponse (Maybe Text)
- lcirCollectionIds :: Lens' ListCollectionIdsResponse [Text]
- data FieldReference
- fieldReference :: FieldReference
- frFieldPath :: Lens' FieldReference (Maybe Text)
- data DocumentRemove
- documentRemove :: DocumentRemove
- drReadTime :: Lens' DocumentRemove (Maybe UTCTime)
- drDocument :: Lens' DocumentRemove (Maybe Text)
- drRemovedTargetIds :: Lens' DocumentRemove [Int32]
- data GoogleFirestoreAdminV1IndexFieldArrayConfig
- data DocumentChange
- documentChange :: DocumentChange
- dcDocument :: Lens' DocumentChange (Maybe Document)
- dcTargetIds :: Lens' DocumentChange [Int32]
- dcRemovedTargetIds :: Lens' DocumentChange [Int32]
- data GoogleFirestoreAdminV1FieldOperationMetadata
- googleFirestoreAdminV1FieldOperationMetadata :: GoogleFirestoreAdminV1FieldOperationMetadata
- gfavfomProgressBytes :: Lens' GoogleFirestoreAdminV1FieldOperationMetadata (Maybe GoogleFirestoreAdminV1Progress)
- gfavfomState :: Lens' GoogleFirestoreAdminV1FieldOperationMetadata (Maybe GoogleFirestoreAdminV1FieldOperationMetadataState)
- gfavfomField :: Lens' GoogleFirestoreAdminV1FieldOperationMetadata (Maybe Text)
- gfavfomStartTime :: Lens' GoogleFirestoreAdminV1FieldOperationMetadata (Maybe UTCTime)
- gfavfomProgressDocuments :: Lens' GoogleFirestoreAdminV1FieldOperationMetadata (Maybe GoogleFirestoreAdminV1Progress)
- gfavfomIndexConfigDeltas :: Lens' GoogleFirestoreAdminV1FieldOperationMetadata [GoogleFirestoreAdminV1IndexConfigDelta]
- gfavfomEndTime :: Lens' GoogleFirestoreAdminV1FieldOperationMetadata (Maybe UTCTime)
- data GoogleFirestoreAdminV1ListIndexesResponse
- googleFirestoreAdminV1ListIndexesResponse :: GoogleFirestoreAdminV1ListIndexesResponse
- gfavlirNextPageToken :: Lens' GoogleFirestoreAdminV1ListIndexesResponse (Maybe Text)
- gfavlirIndexes :: Lens' GoogleFirestoreAdminV1ListIndexesResponse [GoogleFirestoreAdminV1Index]
- data MapValue
- mapValue :: MapValue
- mvFields :: Lens' MapValue (Maybe MapValueFields)
- data BatchGetDocumentsRequest
- batchGetDocumentsRequest :: BatchGetDocumentsRequest
- bReadTime :: Lens' BatchGetDocumentsRequest (Maybe UTCTime)
- bNewTransaction :: Lens' BatchGetDocumentsRequest (Maybe TransactionOptions)
- bTransaction :: Lens' BatchGetDocumentsRequest (Maybe ByteString)
- bDocuments :: Lens' BatchGetDocumentsRequest [Text]
- bMask :: Lens' BatchGetDocumentsRequest (Maybe DocumentMask)
- data Document
- document :: Document
- dUpdateTime :: Lens' Document (Maybe UTCTime)
- dName :: Lens' Document (Maybe Text)
- dCreateTime :: Lens' Document (Maybe UTCTime)
- dFields :: Lens' Document (Maybe DocumentFields)
- data GoogleFirestoreAdminV1IndexOperationMetadataState
- data ArrayValue
- arrayValue :: ArrayValue
- avValues :: Lens' ArrayValue [Value]
- data Xgafv
- data CommitResponse
- commitResponse :: CommitResponse
- crCommitTime :: Lens' CommitResponse (Maybe UTCTime)
- crWriteResults :: Lens' CommitResponse [WriteResult]
- data ListenResponse
- listenResponse :: ListenResponse
- lrTargetChange :: Lens' ListenResponse (Maybe TargetChange)
- lrDocumentRemove :: Lens' ListenResponse (Maybe DocumentRemove)
- lrDocumentChange :: Lens' ListenResponse (Maybe DocumentChange)
- lrFilter :: Lens' ListenResponse (Maybe ExistenceFilter)
- lrDocumentDelete :: Lens' ListenResponse (Maybe DocumentDelete)
- data FieldFilter
- fieldFilter :: FieldFilter
- ffOp :: Lens' FieldFilter (Maybe FieldFilterOp)
- ffField :: Lens' FieldFilter (Maybe FieldReference)
- ffValue :: Lens' FieldFilter (Maybe Value)
- data GoogleLongrunningOperationResponse
- googleLongrunningOperationResponse :: HashMap Text JSONValue -> GoogleLongrunningOperationResponse
- glorAddtional :: Lens' GoogleLongrunningOperationResponse (HashMap Text JSONValue)
- data ListDocumentsResponse
- listDocumentsResponse :: ListDocumentsResponse
- ldrNextPageToken :: Lens' ListDocumentsResponse (Maybe Text)
- ldrDocuments :: Lens' ListDocumentsResponse [Document]
- data GoogleFirestoreAdminV1ExportDocumentsResponse
- googleFirestoreAdminV1ExportDocumentsResponse :: GoogleFirestoreAdminV1ExportDocumentsResponse
- gOutputURIPrefix :: Lens' GoogleFirestoreAdminV1ExportDocumentsResponse (Maybe Text)
- data FieldFilterOp
- data Projection
- projection :: Projection
- pFields :: Lens' Projection [FieldReference]
- data Filter
- filter' :: Filter
- fCompositeFilter :: Lens' Filter (Maybe CompositeFilter)
- fFieldFilter :: Lens' Filter (Maybe FieldFilter)
- fUnaryFilter :: Lens' Filter (Maybe UnaryFilter)
- data TargetChangeTargetChangeType
- data GoogleFirestoreAdminV1IndexOperationMetadata
- googleFirestoreAdminV1IndexOperationMetadata :: GoogleFirestoreAdminV1IndexOperationMetadata
- gfaviomProgressBytes :: Lens' GoogleFirestoreAdminV1IndexOperationMetadata (Maybe GoogleFirestoreAdminV1Progress)
- gfaviomState :: Lens' GoogleFirestoreAdminV1IndexOperationMetadata (Maybe GoogleFirestoreAdminV1IndexOperationMetadataState)
- gfaviomStartTime :: Lens' GoogleFirestoreAdminV1IndexOperationMetadata (Maybe UTCTime)
- gfaviomProgressDocuments :: Lens' GoogleFirestoreAdminV1IndexOperationMetadata (Maybe GoogleFirestoreAdminV1Progress)
- gfaviomEndTime :: Lens' GoogleFirestoreAdminV1IndexOperationMetadata (Maybe UTCTime)
- gfaviomIndex :: Lens' GoogleFirestoreAdminV1IndexOperationMetadata (Maybe Text)
- data LocationLabels
- locationLabels :: HashMap Text Text -> LocationLabels
- llAddtional :: Lens' LocationLabels (HashMap Text Text)
- data ListenRequest
- listenRequest :: ListenRequest
- lrRemoveTarget :: Lens' ListenRequest (Maybe Int32)
- lrLabels :: Lens' ListenRequest (Maybe ListenRequestLabels)
- lrAddTarget :: Lens' ListenRequest (Maybe Target)
- data GoogleFirestoreAdminV1ImportDocumentsMetadataOperationState
- data CommitRequest
- commitRequest :: CommitRequest
- crTransaction :: Lens' CommitRequest (Maybe ByteString)
- crWrites :: Lens' CommitRequest [Write]
- data LocationMetadata
- locationMetadata :: HashMap Text JSONValue -> LocationMetadata
- lmAddtional :: Lens' LocationMetadata (HashMap Text JSONValue)
- data GoogleLongrunningListOperationsResponse
- googleLongrunningListOperationsResponse :: GoogleLongrunningListOperationsResponse
- gllorNextPageToken :: Lens' GoogleLongrunningListOperationsResponse (Maybe Text)
- gllorOperations :: Lens' GoogleLongrunningListOperationsResponse [GoogleLongrunningOperation]
- data GoogleFirestoreAdminV1FieldOperationMetadataState
- data CollectionSelector
- collectionSelector :: CollectionSelector
- csAllDescendants :: Lens' CollectionSelector (Maybe Bool)
- csCollectionId :: Lens' CollectionSelector (Maybe Text)
- data ListCollectionIdsRequest
- listCollectionIdsRequest :: ListCollectionIdsRequest
- lcirPageToken :: Lens' ListCollectionIdsRequest (Maybe Text)
- lcirPageSize :: Lens' ListCollectionIdsRequest (Maybe Int32)
- data WriteResponse
- writeResponse :: WriteResponse
- wStreamToken :: Lens' WriteResponse (Maybe ByteString)
- wCommitTime :: Lens' WriteResponse (Maybe UTCTime)
- wWriteResults :: Lens' WriteResponse [WriteResult]
- wStreamId :: Lens' WriteResponse (Maybe Text)
- data Order
- order :: Order
- oField :: Lens' Order (Maybe FieldReference)
- oDirection :: Lens' Order (Maybe OrderDirection)
- data DocumentDelete
- documentDelete :: DocumentDelete
- ddReadTime :: Lens' DocumentDelete (Maybe UTCTime)
- ddDocument :: Lens' DocumentDelete (Maybe Text)
- ddRemovedTargetIds :: Lens' DocumentDelete [Int32]
- data FieldTransform
- fieldTransform :: FieldTransform
- ftFieldPath :: Lens' FieldTransform (Maybe Text)
- ftAppendMissingElements :: Lens' FieldTransform (Maybe ArrayValue)
- ftSetToServerValue :: Lens' FieldTransform (Maybe FieldTransformSetToServerValue)
- ftRemoveAllFromArray :: Lens' FieldTransform (Maybe ArrayValue)
- data MapValueFields
- mapValueFields :: HashMap Text Value -> MapValueFields
- mvfAddtional :: Lens' MapValueFields (HashMap Text Value)
- data DocumentFields
- documentFields :: HashMap Text Value -> DocumentFields
- dfAddtional :: Lens' DocumentFields (HashMap Text Value)
- data ReadOnly
- readOnly :: ReadOnly
- roReadTime :: Lens' ReadOnly (Maybe UTCTime)
- data Target
- target :: Target
- tTargetId :: Lens' Target (Maybe Int32)
- tOnce :: Lens' Target (Maybe Bool)
- tReadTime :: Lens' Target (Maybe UTCTime)
- tResumeToken :: Lens' Target (Maybe ByteString)
- tDocuments :: Lens' Target (Maybe DocumentsTarget)
- tQuery :: Lens' Target (Maybe QueryTarget)
- data WriteRequestLabels
- writeRequestLabels :: HashMap Text Text -> WriteRequestLabels
- wrlAddtional :: Lens' WriteRequestLabels (HashMap Text Text)
- data FieldTransformSetToServerValue
- data GoogleLongrunningOperation
- googleLongrunningOperation :: GoogleLongrunningOperation
- gloDone :: Lens' GoogleLongrunningOperation (Maybe Bool)
- gloError :: Lens' GoogleLongrunningOperation (Maybe Status)
- gloResponse :: Lens' GoogleLongrunningOperation (Maybe GoogleLongrunningOperationResponse)
- gloName :: Lens' GoogleLongrunningOperation (Maybe Text)
- gloMetadata :: Lens' GoogleLongrunningOperation (Maybe GoogleLongrunningOperationMetadata)
- data GoogleFirestoreAdminV1ExportDocumentsMetadataOperationState
- data UnaryFilter
- unaryFilter :: UnaryFilter
- ufOp :: Lens' UnaryFilter (Maybe UnaryFilterOp)
- ufField :: Lens' UnaryFilter (Maybe FieldReference)
Service Configuration
fireStoreService :: ServiceConfig Source #
Default request referring to version v1
of the Cloud Firestore API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
datastoreScope :: Proxy '["https://www.googleapis.com/auth/datastore"] Source #
View and manage your Google Cloud Datastore data
API Declaration
type FireStoreAPI = ProjectsLocationsListResource :<|> (ProjectsLocationsGetResource :<|> (ProjectsDatabasesDocumentsListCollectionIdsResource :<|> (ProjectsDatabasesDocumentsListResource :<|> (ProjectsDatabasesDocumentsWriteResource :<|> (ProjectsDatabasesDocumentsCreateDocumentResource :<|> (ProjectsDatabasesDocumentsBeginTransactionResource :<|> (ProjectsDatabasesDocumentsRunQueryResource :<|> (ProjectsDatabasesDocumentsPatchResource :<|> (ProjectsDatabasesDocumentsGetResource :<|> (ProjectsDatabasesDocumentsRollbackResource :<|> (ProjectsDatabasesDocumentsBatchGetResource :<|> (ProjectsDatabasesDocumentsDeleteResource :<|> (ProjectsDatabasesDocumentsListenResource :<|> (ProjectsDatabasesDocumentsCommitResource :<|> (ProjectsDatabasesCollectionGroupsIndexesListResource :<|> (ProjectsDatabasesCollectionGroupsIndexesGetResource :<|> (ProjectsDatabasesCollectionGroupsIndexesCreateResource :<|> (ProjectsDatabasesCollectionGroupsIndexesDeleteResource :<|> (ProjectsDatabasesCollectionGroupsFieldsListResource :<|> (ProjectsDatabasesCollectionGroupsFieldsPatchResource :<|> (ProjectsDatabasesCollectionGroupsFieldsGetResource :<|> (ProjectsDatabasesOperationsListResource :<|> (ProjectsDatabasesOperationsGetResource :<|> (ProjectsDatabasesOperationsCancelResource :<|> (ProjectsDatabasesOperationsDeleteResource :<|> (ProjectsDatabasesExportDocumentsResource :<|> ProjectsDatabasesImportDocumentsResource)))))))))))))))))))))))))) Source #
Represents the entirety of the methods and resources available for the Cloud Firestore API service.
Resources
firestore.projects.databases.collectionGroups.fields.get
firestore.projects.databases.collectionGroups.fields.list
firestore.projects.databases.collectionGroups.fields.patch
firestore.projects.databases.collectionGroups.indexes.create
firestore.projects.databases.collectionGroups.indexes.delete
firestore.projects.databases.collectionGroups.indexes.get
firestore.projects.databases.collectionGroups.indexes.list
firestore.projects.databases.documents.batchGet
firestore.projects.databases.documents.beginTransaction
firestore.projects.databases.documents.commit
firestore.projects.databases.documents.createDocument
firestore.projects.databases.documents.delete
firestore.projects.databases.documents.get
firestore.projects.databases.documents.list
firestore.projects.databases.documents.listCollectionIds
firestore.projects.databases.documents.listen
firestore.projects.databases.documents.patch
firestore.projects.databases.documents.rollback
firestore.projects.databases.documents.runQuery
firestore.projects.databases.documents.write
firestore.projects.databases.exportDocuments
firestore.projects.databases.importDocuments
firestore.projects.databases.operations.cancel
firestore.projects.databases.operations.delete
firestore.projects.databases.operations.get
firestore.projects.databases.operations.list
firestore.projects.locations.get
firestore.projects.locations.list
Types
WriteRequest
data WriteRequest Source #
The request for Firestore.Write. The first request creates a stream, or resumes an existing one from a token. When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request. When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.
See: writeRequest
smart constructor.
Instances
writeRequest :: WriteRequest Source #
Creates a value of WriteRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wrStreamToken :: Lens' WriteRequest (Maybe ByteString) Source #
A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the `stream_id` field. Leave this field unset when creating a new stream.
wrLabels :: Lens' WriteRequest (Maybe WriteRequestLabels) Source #
Labels associated with this write request.
wrWrites :: Lens' WriteRequest [Write] Source #
The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.
wrStreamId :: Lens' WriteRequest (Maybe Text) Source #
The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.
LatLng
An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.
See: latLng
smart constructor.
Instances
Eq LatLng Source # | |
Data LatLng Source # | |
Defined in Network.Google.FireStore.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LatLng -> c LatLng # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LatLng # toConstr :: LatLng -> Constr # dataTypeOf :: LatLng -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LatLng) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LatLng) # gmapT :: (forall b. Data b => b -> b) -> LatLng -> LatLng # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LatLng -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LatLng -> r # gmapQ :: (forall d. Data d => d -> u) -> LatLng -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> LatLng -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> LatLng -> m LatLng # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LatLng -> m LatLng # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LatLng -> m LatLng # | |
Show LatLng Source # | |
Generic LatLng Source # | |
ToJSON LatLng Source # | |
Defined in Network.Google.FireStore.Types.Product | |
FromJSON LatLng Source # | |
type Rep LatLng Source # | |
Defined in Network.Google.FireStore.Types.Product type Rep LatLng = D1 (MetaData "LatLng" "Network.Google.FireStore.Types.Product" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "LatLng'" PrefixI True) (S1 (MetaSel (Just "_llLatitude") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double))) :*: S1 (MetaSel (Just "_llLongitude") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double))))) |
Creates a value of LatLng
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llLatitude :: Lens' LatLng (Maybe Double) Source #
The latitude in degrees. It must be in the range [-90.0, +90.0].
llLongitude :: Lens' LatLng (Maybe Double) Source #
The longitude in degrees. It must be in the range [-180.0, +180.0].
GoogleFirestoreAdminV1IndexFieldOrder
data GoogleFirestoreAdminV1IndexFieldOrder Source #
Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
OrderUnspecified |
|
Ascending |
|
Descending |
|
Instances
WriteResult
data WriteResult Source #
The result of applying a write.
See: writeResult
smart constructor.
Instances
writeResult :: WriteResult Source #
Creates a value of WriteResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wrUpdateTime :: Lens' WriteResult (Maybe UTCTime) Source #
The last update time of the document after applying the write. Not set after a `delete`. If the write did not actually change the document, this will be the previous update_time.
wrTransformResults :: Lens' WriteResult [Value] Source #
The results of applying each DocumentTransform.FieldTransform, in the same order.
GoogleFirestoreAdminV1Field
data GoogleFirestoreAdminV1Field Source #
Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.
See: googleFirestoreAdminV1Field
smart constructor.
Instances
googleFirestoreAdminV1Field :: GoogleFirestoreAdminV1Field Source #
Creates a value of GoogleFirestoreAdminV1Field
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfavfIndexConfig :: Lens' GoogleFirestoreAdminV1Field (Maybe GoogleFirestoreAdminV1IndexConfig) Source #
The index configuration for this field. If unset, field indexing will revert to the configuration defined by the `ancestor_field`. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes.
gfavfName :: Lens' GoogleFirestoreAdminV1Field (Maybe Text) Source #
A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/default/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration.
TransactionOptions
data TransactionOptions Source #
Options for creating a new transaction.
See: transactionOptions
smart constructor.
Instances
transactionOptions :: TransactionOptions Source #
Creates a value of TransactionOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
toReadWrite :: Lens' TransactionOptions (Maybe ReadWrite) Source #
The transaction can be used for both read and write operations.
toReadOnly :: Lens' TransactionOptions (Maybe ReadOnly) Source #
The transaction can only be used for read operations.
GoogleFirestoreAdminV1IndexConfigDeltaChangeType
data GoogleFirestoreAdminV1IndexConfigDeltaChangeType Source #
Specifies how the index is changing.
ChangeTypeUnspecified |
|
Add |
|
Remove |
|
Instances
Status
The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
See: status
smart constructor.
Instances
Eq Status Source # | |
Data Status Source # | |
Defined in Network.Google.FireStore.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Status -> c Status # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Status # toConstr :: Status -> Constr # dataTypeOf :: Status -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Status) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status) # gmapT :: (forall b. Data b => b -> b) -> Status -> Status # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQ :: (forall d. Data d => d -> u) -> Status -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Status -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # | |
Show Status Source # | |
Generic Status Source # | |
ToJSON Status Source # | |
Defined in Network.Google.FireStore.Types.Product | |
FromJSON Status Source # | |
type Rep Status Source # | |
Defined in Network.Google.FireStore.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.FireStore.Types.Product" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "Status'" PrefixI True) (S1 (MetaSel (Just "_sDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StatusDetailsItem])) :*: (S1 (MetaSel (Just "_sCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_sMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There is a common set of message types for APIs to use.
sCode :: Lens' Status (Maybe Int32) Source #
The status code, which should be an enum value of google.rpc.Code.
sMessage :: Lens' Status (Maybe Text) Source #
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
GoogleLongrunningOperationMetadata
data GoogleLongrunningOperationMetadata Source #
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
See: googleLongrunningOperationMetadata
smart constructor.
Instances
googleLongrunningOperationMetadata Source #
Creates a value of GoogleLongrunningOperationMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
glomAddtional :: Lens' GoogleLongrunningOperationMetadata (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
Precondition
data Precondition Source #
A precondition on a document, used for conditional operations.
See: precondition
smart constructor.
Instances
precondition :: Precondition Source #
Creates a value of Precondition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pExists :: Lens' Precondition (Maybe Bool) Source #
When set to `true`, the target document must exist. When set to `false`, the target document must not exist.
pUpdateTime :: Lens' Precondition (Maybe UTCTime) Source #
When set, the target document must exist and have been last updated at that time.
ReadWrite
Options for a transaction that can be used to read and write documents.
See: readWrite
smart constructor.
Instances
Eq ReadWrite Source # | |
Data ReadWrite Source # | |
Defined in Network.Google.FireStore.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReadWrite -> c ReadWrite # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReadWrite # toConstr :: ReadWrite -> Constr # dataTypeOf :: ReadWrite -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ReadWrite) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReadWrite) # gmapT :: (forall b. Data b => b -> b) -> ReadWrite -> ReadWrite # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReadWrite -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReadWrite -> r # gmapQ :: (forall d. Data d => d -> u) -> ReadWrite -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ReadWrite -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReadWrite -> m ReadWrite # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReadWrite -> m ReadWrite # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReadWrite -> m ReadWrite # | |
Show ReadWrite Source # | |
Generic ReadWrite Source # | |
ToJSON ReadWrite Source # | |
Defined in Network.Google.FireStore.Types.Product | |
FromJSON ReadWrite Source # | |
type Rep ReadWrite Source # | |
Defined in Network.Google.FireStore.Types.Product |
readWrite :: ReadWrite Source #
Creates a value of ReadWrite
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rwRetryTransaction :: Lens' ReadWrite (Maybe ByteString) Source #
An optional transaction to retry.
RollbackRequest
data RollbackRequest Source #
The request for Firestore.Rollback.
See: rollbackRequest
smart constructor.
Instances
rollbackRequest :: RollbackRequest Source #
Creates a value of RollbackRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrTransaction :: Lens' RollbackRequest (Maybe ByteString) Source #
The transaction to roll back.
GoogleFirestoreAdminV1ExportDocumentsRequest
data GoogleFirestoreAdminV1ExportDocumentsRequest Source #
The request for FirestoreAdmin.ExportDocuments.
See: googleFirestoreAdminV1ExportDocumentsRequest
smart constructor.
Instances
googleFirestoreAdminV1ExportDocumentsRequest :: GoogleFirestoreAdminV1ExportDocumentsRequest Source #
Creates a value of GoogleFirestoreAdminV1ExportDocumentsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfavedrCollectionIds :: Lens' GoogleFirestoreAdminV1ExportDocumentsRequest [Text] Source #
Which collection ids to export. Unspecified means all collections.
gfavedrOutputURIPrefix :: Lens' GoogleFirestoreAdminV1ExportDocumentsRequest (Maybe Text) Source #
The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.
TargetChange
data TargetChange Source #
Targets being watched have changed.
See: targetChange
smart constructor.
Instances
targetChange :: TargetChange Source #
Creates a value of TargetChange
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tcReadTime :: Lens' TargetChange (Maybe UTCTime) Source #
The consistent `read_time` for the given `target_ids` (omitted when the target_ids are not at a consistent snapshot). The stream is guaranteed to send a `read_time` with `target_ids` empty whenever the entire stream reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to (eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE messages are not). For a given stream, `read_time` is guaranteed to be monotonically increasing.
tcResumeToken :: Lens' TargetChange (Maybe ByteString) Source #
A token that can be used to resume the stream for the given `target_ids`, or all targets if `target_ids` is empty. Not set on every target change.
tcCause :: Lens' TargetChange (Maybe Status) Source #
The error that resulted in this change, if applicable.
tcTargetChangeType :: Lens' TargetChange (Maybe TargetChangeTargetChangeType) Source #
The type of change that occurred.
tcTargetIds :: Lens' TargetChange [Int32] Source #
The target IDs of targets that have changed. If empty, the change applies to all targets. For `target_change_type=ADD`, the order of the target IDs matches the order of the requests to add the targets. This allows clients to unambiguously associate server-assigned target IDs with added targets. For other states, the order of the target IDs is not defined.
ListLocationsResponse
data ListLocationsResponse Source #
The response message for Locations.ListLocations.
See: listLocationsResponse
smart constructor.
Instances
listLocationsResponse :: ListLocationsResponse Source #
Creates a value of ListLocationsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llrNextPageToken :: Lens' ListLocationsResponse (Maybe Text) Source #
The standard List next-page token.
llrLocations :: Lens' ListLocationsResponse [Location] Source #
A list of locations that matches the specified filter in the request.
GoogleFirestoreAdminV1IndexState
data GoogleFirestoreAdminV1IndexState Source #
Output only. The serving state of the index.
StateUnspecified |
|
Creating |
|
Ready |
|
NeedsRepair |
|
Instances
CompositeFilterOp
data CompositeFilterOp Source #
The operator for combining multiple filters.
OperatorUnspecified |
|
And |
|
Instances
Cursor
A position in a query result set.
See: cursor
smart constructor.
Instances
Eq Cursor Source # | |
Data Cursor Source # | |
Defined in Network.Google.FireStore.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Cursor -> c Cursor # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Cursor # toConstr :: Cursor -> Constr # dataTypeOf :: Cursor -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Cursor) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Cursor) # gmapT :: (forall b. Data b => b -> b) -> Cursor -> Cursor # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Cursor -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Cursor -> r # gmapQ :: (forall d. Data d => d -> u) -> Cursor -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Cursor -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Cursor -> m Cursor # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Cursor -> m Cursor # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Cursor -> m Cursor # | |
Show Cursor Source # | |
Generic Cursor Source # | |
ToJSON Cursor Source # | |
Defined in Network.Google.FireStore.Types.Product | |
FromJSON Cursor Source # | |
type Rep Cursor Source # | |
Defined in Network.Google.FireStore.Types.Product type Rep Cursor = D1 (MetaData "Cursor" "Network.Google.FireStore.Types.Product" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "Cursor'" PrefixI True) (S1 (MetaSel (Just "_cValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Value])) :*: S1 (MetaSel (Just "_cBefore") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) |
cValues :: Lens' Cursor [Value] Source #
The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause.
cBefore :: Lens' Cursor (Maybe Bool) Source #
If the position is just before or just after the given values, relative to the sort order defined by the query.
GoogleFirestoreAdminV1ImportDocumentsMetadata
data GoogleFirestoreAdminV1ImportDocumentsMetadata Source #
Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments.
See: googleFirestoreAdminV1ImportDocumentsMetadata
smart constructor.
Instances
googleFirestoreAdminV1ImportDocumentsMetadata :: GoogleFirestoreAdminV1ImportDocumentsMetadata Source #
Creates a value of GoogleFirestoreAdminV1ImportDocumentsMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfavidmProgressBytes :: Lens' GoogleFirestoreAdminV1ImportDocumentsMetadata (Maybe GoogleFirestoreAdminV1Progress) Source #
The progress, in bytes, of this operation.
gfavidmStartTime :: Lens' GoogleFirestoreAdminV1ImportDocumentsMetadata (Maybe UTCTime) Source #
The time this operation started.
gfavidmInputURIPrefix :: Lens' GoogleFirestoreAdminV1ImportDocumentsMetadata (Maybe Text) Source #
The location of the documents being imported.
gfavidmCollectionIds :: Lens' GoogleFirestoreAdminV1ImportDocumentsMetadata [Text] Source #
Which collection ids are being imported.
gfavidmProgressDocuments :: Lens' GoogleFirestoreAdminV1ImportDocumentsMetadata (Maybe GoogleFirestoreAdminV1Progress) Source #
The progress, in documents, of this operation.
gfavidmEndTime :: Lens' GoogleFirestoreAdminV1ImportDocumentsMetadata (Maybe UTCTime) Source #
The time this operation completed. Will be unset if operation still in progress.
gfavidmOperationState :: Lens' GoogleFirestoreAdminV1ImportDocumentsMetadata (Maybe GoogleFirestoreAdminV1ImportDocumentsMetadataOperationState) Source #
The state of the import operation.
BeginTransactionRequest
data BeginTransactionRequest Source #
The request for Firestore.BeginTransaction.
See: beginTransactionRequest
smart constructor.
Instances
beginTransactionRequest :: BeginTransactionRequest Source #
Creates a value of BeginTransactionRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
btrOptions :: Lens' BeginTransactionRequest (Maybe TransactionOptions) Source #
The options for the transaction. Defaults to a read-write transaction.
RunQueryRequest
data RunQueryRequest Source #
The request for Firestore.RunQuery.
See: runQueryRequest
smart constructor.
Instances
runQueryRequest :: RunQueryRequest Source #
Creates a value of RunQueryRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rqrReadTime :: Lens' RunQueryRequest (Maybe UTCTime) Source #
Reads documents as they were at the given time. This may not be older than 60 seconds.
rqrNewTransaction :: Lens' RunQueryRequest (Maybe TransactionOptions) Source #
Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
rqrStructuredQuery :: Lens' RunQueryRequest (Maybe StructuredQuery) Source #
A structured query.
rqrTransaction :: Lens' RunQueryRequest (Maybe ByteString) Source #
Reads documents in a transaction.
GoogleFirestoreAdminV1IndexConfigDelta
data GoogleFirestoreAdminV1IndexConfigDelta Source #
Information about an index configuration change.
See: googleFirestoreAdminV1IndexConfigDelta
smart constructor.
Instances
googleFirestoreAdminV1IndexConfigDelta :: GoogleFirestoreAdminV1IndexConfigDelta Source #
Creates a value of GoogleFirestoreAdminV1IndexConfigDelta
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfavicdIndex :: Lens' GoogleFirestoreAdminV1IndexConfigDelta (Maybe GoogleFirestoreAdminV1Index) Source #
The index being changed.
gfavicdChangeType :: Lens' GoogleFirestoreAdminV1IndexConfigDelta (Maybe GoogleFirestoreAdminV1IndexConfigDeltaChangeType) Source #
Specifies how the index is changing.
GoogleFirestoreAdminV1IndexConfig
data GoogleFirestoreAdminV1IndexConfig Source #
The index configuration for this field.
See: googleFirestoreAdminV1IndexConfig
smart constructor.
Instances
googleFirestoreAdminV1IndexConfig :: GoogleFirestoreAdminV1IndexConfig Source #
Creates a value of GoogleFirestoreAdminV1IndexConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfavicAncestorField :: Lens' GoogleFirestoreAdminV1IndexConfig (Maybe Text) Source #
Output only. Specifies the resource name of the `Field` from which this field's index configuration is set (when `uses_ancestor_config` is true), or from which it *would* be set if this field had no index configuration (when `uses_ancestor_config` is false).
gfavicReverting :: Lens' GoogleFirestoreAdminV1IndexConfig (Maybe Bool) Source #
Output only When true, the `Field`'s index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by `ancestor_field`, at which point `uses_ancestor_config` will be `true` and `reverting` will be `false`.
gfavicIndexes :: Lens' GoogleFirestoreAdminV1IndexConfig [GoogleFirestoreAdminV1Index] Source #
The indexes supported for this field.
gfavicUsesAncestorConfig :: Lens' GoogleFirestoreAdminV1IndexConfig (Maybe Bool) Source #
Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly.
GoogleFirestoreAdminV1IndexField
data GoogleFirestoreAdminV1IndexField Source #
A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
See: googleFirestoreAdminV1IndexField
smart constructor.
Instances
googleFirestoreAdminV1IndexField :: GoogleFirestoreAdminV1IndexField Source #
Creates a value of GoogleFirestoreAdminV1IndexField
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfavifFieldPath :: Lens' GoogleFirestoreAdminV1IndexField (Maybe Text) Source #
Can be name. For single field indexes, this must match the name of the field or may be omitted.
gfavifArrayConfig :: Lens' GoogleFirestoreAdminV1IndexField (Maybe GoogleFirestoreAdminV1IndexFieldArrayConfig) Source #
Indicates that this field supports operations on `array_value`s.
gfavifOrder :: Lens' GoogleFirestoreAdminV1IndexField (Maybe GoogleFirestoreAdminV1IndexFieldOrder) Source #
Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
Write
A write on a document.
See: write
smart constructor.
Instances
Eq Write Source # | |
Data Write Source # | |
Defined in Network.Google.FireStore.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Write -> c Write # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Write # dataTypeOf :: Write -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Write) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Write) # gmapT :: (forall b. Data b => b -> b) -> Write -> Write # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Write -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Write -> r # gmapQ :: (forall d. Data d => d -> u) -> Write -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Write -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Write -> m Write # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Write -> m Write # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Write -> m Write # | |
Show Write Source # | |
Generic Write Source # | |
ToJSON Write Source # | |
Defined in Network.Google.FireStore.Types.Product | |
FromJSON Write Source # | |
type Rep Write Source # | |
Defined in Network.Google.FireStore.Types.Product type Rep Write = D1 (MetaData "Write" "Network.Google.FireStore.Types.Product" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "Write'" PrefixI True) ((S1 (MetaSel (Just "_wTransform") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DocumentTransform)) :*: S1 (MetaSel (Just "_wUpdateMask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DocumentMask))) :*: (S1 (MetaSel (Just "_wCurrentDocument") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Precondition)) :*: (S1 (MetaSel (Just "_wDelete") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_wUpdate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Document)))))) |
Creates a value of Write
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wTransform :: Lens' Write (Maybe DocumentTransform) Source #
Applies a tranformation to a document. At most one `transform` per document is allowed in a given request. An `update` cannot follow a `transform` on the same document in a given request.
wUpdateMask :: Lens' Write (Maybe DocumentMask) Source #
The fields to update in this write. This field can be set only when the operation is `update`. If the mask is not set for an `update` and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. The field paths in this mask must not contain a reserved field name.
wCurrentDocument :: Lens' Write (Maybe Precondition) Source #
An optional precondition on the document. The write will fail if this is set and not met by the target document.
wDelete :: Lens' Write (Maybe Text) Source #
A document name to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
Location
A resource that represents Google Cloud Platform location.
See: location
smart constructor.
Instances
Creates a value of Location
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lName :: Lens' Location (Maybe Text) Source #
Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
lMetadata :: Lens' Location (Maybe LocationMetadata) Source #
Service-specific metadata. For example the available capacity at the given location.
lDisplayName :: Lens' Location (Maybe Text) Source #
The friendly name for this location, typically a nearby city name. For example, "Tokyo".
lLabels :: Lens' Location (Maybe LocationLabels) Source #
Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
lLocationId :: Lens' Location (Maybe Text) Source #
The canonical id for this location. For example: `"us-east1"`.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
See: empty
smart constructor.
Instances
Eq Empty Source # | |
Data Empty Source # | |
Defined in Network.Google.FireStore.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
Show Empty Source # | |
Generic Empty Source # | |
ToJSON Empty Source # | |
Defined in Network.Google.FireStore.Types.Product | |
FromJSON Empty Source # | |
type Rep Empty Source # | |
BatchGetDocumentsResponse
data BatchGetDocumentsResponse Source #
The streamed response for Firestore.BatchGetDocuments.
See: batchGetDocumentsResponse
smart constructor.
Instances
batchGetDocumentsResponse :: BatchGetDocumentsResponse Source #
Creates a value of BatchGetDocumentsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bgdrReadTime :: Lens' BatchGetDocumentsResponse (Maybe UTCTime) Source #
The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.
bgdrFound :: Lens' BatchGetDocumentsResponse (Maybe Document) Source #
A document that was requested.
bgdrTransaction :: Lens' BatchGetDocumentsResponse (Maybe ByteString) Source #
The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request.
bgdrMissing :: Lens' BatchGetDocumentsResponse (Maybe Text) Source #
A document name that was requested but does not exist. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
CompositeFilter
data CompositeFilter Source #
A filter that merges multiple other filters using the given operator.
See: compositeFilter
smart constructor.
Instances
compositeFilter :: CompositeFilter Source #
Creates a value of CompositeFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cfOp :: Lens' CompositeFilter (Maybe CompositeFilterOp) Source #
The operator for combining multiple filters.
cfFilters :: Lens' CompositeFilter [Filter] Source #
The list of filters to combine. Must contain at least one filter.
DocumentsTarget
data DocumentsTarget Source #
A target specified by a set of documents names.
See: documentsTarget
smart constructor.
Instances
documentsTarget :: DocumentsTarget Source #
Creates a value of DocumentsTarget
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dtDocuments :: Lens' DocumentsTarget [Text] Source #
The names of the documents to retrieve. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided.
ListenRequestLabels
data ListenRequestLabels Source #
Labels associated with this target change.
See: listenRequestLabels
smart constructor.
Instances
Creates a value of ListenRequestLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
GoogleFirestoreAdminV1Index
data GoogleFirestoreAdminV1Index Source #
Cloud Firestore indexes enable simple and complex queries against documents in a database.
See: googleFirestoreAdminV1Index
smart constructor.
Instances
googleFirestoreAdminV1Index :: GoogleFirestoreAdminV1Index Source #
Creates a value of GoogleFirestoreAdminV1Index
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfaviState :: Lens' GoogleFirestoreAdminV1Index (Maybe GoogleFirestoreAdminV1IndexState) Source #
Output only. The serving state of the index.
gfaviQueryScope :: Lens' GoogleFirestoreAdminV1Index (Maybe GoogleFirestoreAdminV1IndexQueryScope) Source #
Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
gfaviName :: Lens' GoogleFirestoreAdminV1Index (Maybe Text) Source #
Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.
gfaviFields :: Lens' GoogleFirestoreAdminV1Index [GoogleFirestoreAdminV1IndexField] Source #
The fields supported by this index. For composite indexes, this is always 2 or more fields. The last field entry is always for the field path `name`. If, on creation, `name` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `name` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
BeginTransactionResponse
data BeginTransactionResponse Source #
The response for Firestore.BeginTransaction.
See: beginTransactionResponse
smart constructor.
Instances
beginTransactionResponse :: BeginTransactionResponse Source #
Creates a value of BeginTransactionResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
btrTransaction :: Lens' BeginTransactionResponse (Maybe ByteString) Source #
The transaction that was started.
RunQueryResponse
data RunQueryResponse Source #
The response for Firestore.RunQuery.
See: runQueryResponse
smart constructor.
Instances
runQueryResponse :: RunQueryResponse Source #
Creates a value of RunQueryResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rReadTime :: Lens' RunQueryResponse (Maybe UTCTime) Source #
The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run.
rSkippedResults :: Lens' RunQueryResponse (Maybe Int32) Source #
The number of results that have been skipped due to an offset between the last response and the current response.
rTransaction :: Lens' RunQueryResponse (Maybe ByteString) Source #
The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.
rDocument :: Lens' RunQueryResponse (Maybe Document) Source #
A query result. Not set when reporting partial progress.
GoogleFirestoreAdminV1IndexQueryScope
data GoogleFirestoreAdminV1IndexQueryScope Source #
Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
QueryScopeUnspecified |
|
Collection |
|
Instances
GoogleFirestoreAdminV1ExportDocumentsMetadata
data GoogleFirestoreAdminV1ExportDocumentsMetadata Source #
Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.
See: googleFirestoreAdminV1ExportDocumentsMetadata
smart constructor.
Instances
googleFirestoreAdminV1ExportDocumentsMetadata :: GoogleFirestoreAdminV1ExportDocumentsMetadata Source #
Creates a value of GoogleFirestoreAdminV1ExportDocumentsMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfavedmProgressBytes :: Lens' GoogleFirestoreAdminV1ExportDocumentsMetadata (Maybe GoogleFirestoreAdminV1Progress) Source #
The progress, in bytes, of this operation.
gfavedmStartTime :: Lens' GoogleFirestoreAdminV1ExportDocumentsMetadata (Maybe UTCTime) Source #
The time this operation started.
gfavedmCollectionIds :: Lens' GoogleFirestoreAdminV1ExportDocumentsMetadata [Text] Source #
Which collection ids are being exported.
gfavedmProgressDocuments :: Lens' GoogleFirestoreAdminV1ExportDocumentsMetadata (Maybe GoogleFirestoreAdminV1Progress) Source #
The progress, in documents, of this operation.
gfavedmEndTime :: Lens' GoogleFirestoreAdminV1ExportDocumentsMetadata (Maybe UTCTime) Source #
The time this operation completed. Will be unset if operation still in progress.
gfavedmOperationState :: Lens' GoogleFirestoreAdminV1ExportDocumentsMetadata (Maybe GoogleFirestoreAdminV1ExportDocumentsMetadataOperationState) Source #
The state of the export operation.
gfavedmOutputURIPrefix :: Lens' GoogleFirestoreAdminV1ExportDocumentsMetadata (Maybe Text) Source #
Where the entities are being exported to.
GoogleFirestoreAdminV1Progress
data GoogleFirestoreAdminV1Progress Source #
Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used.
See: googleFirestoreAdminV1Progress
smart constructor.
Instances
googleFirestoreAdminV1Progress :: GoogleFirestoreAdminV1Progress Source #
Creates a value of GoogleFirestoreAdminV1Progress
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfavpCompletedWork :: Lens' GoogleFirestoreAdminV1Progress (Maybe Int64) Source #
The amount of work completed.
gfavpEstimatedWork :: Lens' GoogleFirestoreAdminV1Progress (Maybe Int64) Source #
The amount of work estimated.
DocumentMask
data DocumentMask Source #
A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document, and takes in account the dynamic nature of Value.
See: documentMask
smart constructor.
Instances
documentMask :: DocumentMask Source #
Creates a value of DocumentMask
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dmFieldPaths :: Lens' DocumentMask [Text] Source #
The list of field paths in the mask. See Document.fields for a field path syntax reference.
QueryTarget
data QueryTarget Source #
A target specified by a query.
See: queryTarget
smart constructor.
Instances
queryTarget :: QueryTarget Source #
Creates a value of QueryTarget
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qtParent :: Lens' QueryTarget (Maybe 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`
qtStructuredQuery :: Lens' QueryTarget (Maybe StructuredQuery) Source #
A structured query.
Value
A message that can hold any of the supported value types.
See: value
smart constructor.
Instances
Creates a value of Value
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vGeoPointValue :: Lens' Value (Maybe LatLng) Source #
A geo point value representing a point on the surface of Earth.
vBytesValue :: Lens' Value (Maybe ByteString) Source #
A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
vTimestampValue :: Lens' Value (Maybe UTCTime) Source #
A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
vStringValue :: Lens' Value (Maybe Text) Source #
A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
vArrayValue :: Lens' Value (Maybe ArrayValue) Source #
An array value. Cannot directly contain another array value, though can contain an map which contains another array.
vReferenceValue :: Lens' Value (Maybe Text) Source #
A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
vNullValue :: Lens' Value (Maybe ValueNullValue) Source #
A null value.
OrderDirection
data OrderDirection Source #
The direction to order by. Defaults to `ASCENDING`.
ODDirectionUnspecified |
|
ODAscending |
|
ODDescending |
|
Instances
ValueNullValue
data ValueNullValue Source #
A null value.
NullValue |
|
Instances
StatusDetailsItem
data StatusDetailsItem Source #
Instances
Creates a value of StatusDetailsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
DocumentTransform
data DocumentTransform Source #
A transformation of a document.
See: documentTransform
smart constructor.
Instances
documentTransform :: DocumentTransform Source #
Creates a value of DocumentTransform
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dtDocument :: Lens' DocumentTransform (Maybe Text) Source #
The name of the document to transform.
dtFieldTransforms :: Lens' DocumentTransform [FieldTransform] Source #
The list of transformations to apply to the fields of the document, in order. This must not be empty.
StructuredQuery
data StructuredQuery Source #
A Firestore query.
See: structuredQuery
smart constructor.
Instances
sqOrderBy :: Lens' StructuredQuery [Order] Source #
The order to apply to the query results. Firestore guarantees a stable ordering through the following rules: * Any field required to appear in `order_by`, that is not already specified in `order_by`, is appended to the order in field name order by default. * If an order on `name` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `SELECT * FROM Foo ORDER BY A` becomes `SELECT * FROM Foo ORDER BY A, name` * `SELECT * FROM Foo ORDER BY A DESC` becomes `SELECT * FROM Foo ORDER BY A DESC, name DESC` * `SELECT * FROM Foo WHERE A > 1` becomes `SELECT * FROM Foo WHERE A > 1 ORDER BY A, name`
sqOffSet :: Lens' StructuredQuery (Maybe Int32) Source #
The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified.
sqFrom :: Lens' StructuredQuery [CollectionSelector] Source #
The collections to query.
sqLimit :: Lens' StructuredQuery (Maybe Int32) Source #
The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.
sqSelect :: Lens' StructuredQuery (Maybe Projection) Source #
The projection to return.
ExistenceFilter
data ExistenceFilter Source #
A digest of all the documents that match a given target.
See: existenceFilter
smart constructor.
Instances
existenceFilter :: ExistenceFilter Source #
Creates a value of ExistenceFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
efTargetId :: Lens' ExistenceFilter (Maybe Int32) Source #
The target ID to which this filter applies.
efCount :: Lens' ExistenceFilter (Maybe Int32) Source #
The total count of documents that match target_id. If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target.
GoogleFirestoreAdminV1ListFieldsResponse
data GoogleFirestoreAdminV1ListFieldsResponse Source #
The response for FirestoreAdmin.ListFields.
See: googleFirestoreAdminV1ListFieldsResponse
smart constructor.
Instances
googleFirestoreAdminV1ListFieldsResponse :: GoogleFirestoreAdminV1ListFieldsResponse Source #
Creates a value of GoogleFirestoreAdminV1ListFieldsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfavlfrNextPageToken :: Lens' GoogleFirestoreAdminV1ListFieldsResponse (Maybe Text) Source #
A page token that may be used to request another page of results. If blank, this is the last page.
gfavlfrFields :: Lens' GoogleFirestoreAdminV1ListFieldsResponse [GoogleFirestoreAdminV1Field] Source #
The requested fields.
GoogleFirestoreAdminV1ImportDocumentsRequest
data GoogleFirestoreAdminV1ImportDocumentsRequest Source #
The request for FirestoreAdmin.ImportDocuments.
See: googleFirestoreAdminV1ImportDocumentsRequest
smart constructor.
Instances
googleFirestoreAdminV1ImportDocumentsRequest :: GoogleFirestoreAdminV1ImportDocumentsRequest Source #
Creates a value of GoogleFirestoreAdminV1ImportDocumentsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfavidrInputURIPrefix :: Lens' GoogleFirestoreAdminV1ImportDocumentsRequest (Maybe Text) Source #
Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.
gfavidrCollectionIds :: Lens' GoogleFirestoreAdminV1ImportDocumentsRequest [Text] Source #
Which collection ids to import. Unspecified means all collections included in the import.
GoogleFirestoreAdminV1LocationMetadata
data GoogleFirestoreAdminV1LocationMetadata Source #
The metadata message for google.cloud.location.Location.metadata.
See: googleFirestoreAdminV1LocationMetadata
smart constructor.
Instances
googleFirestoreAdminV1LocationMetadata :: GoogleFirestoreAdminV1LocationMetadata Source #
Creates a value of GoogleFirestoreAdminV1LocationMetadata
with the minimum fields required to make a request.
GoogleLongrunningCancelOperationRequest
data GoogleLongrunningCancelOperationRequest Source #
The request message for Operations.CancelOperation.
See: googleLongrunningCancelOperationRequest
smart constructor.
Instances
googleLongrunningCancelOperationRequest :: GoogleLongrunningCancelOperationRequest Source #
Creates a value of GoogleLongrunningCancelOperationRequest
with the minimum fields required to make a request.
UnaryFilterOp
data UnaryFilterOp Source #
The unary operator to apply.
UFOOperatorUnspecified |
|
UFOIsNan |
|
UFOIsNull |
|
Instances
ListCollectionIdsResponse
data ListCollectionIdsResponse Source #
The response from Firestore.ListCollectionIds.
See: listCollectionIdsResponse
smart constructor.
Instances
listCollectionIdsResponse :: ListCollectionIdsResponse Source #
Creates a value of ListCollectionIdsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcirNextPageToken :: Lens' ListCollectionIdsResponse (Maybe Text) Source #
A page token that may be used to continue the list.
lcirCollectionIds :: Lens' ListCollectionIdsResponse [Text] Source #
The collection ids.
FieldReference
data FieldReference Source #
A reference to a field, such as `max(messages.time) as max_time`.
See: fieldReference
smart constructor.
Instances
fieldReference :: FieldReference Source #
Creates a value of FieldReference
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
DocumentRemove
data DocumentRemove Source #
A Document has been removed from the view of the targets. Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document. Multiple DocumentRemove messages may be returned for the same logical write or delete, if multiple targets are affected.
See: documentRemove
smart constructor.
Instances
documentRemove :: DocumentRemove Source #
Creates a value of DocumentRemove
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drReadTime :: Lens' DocumentRemove (Maybe UTCTime) Source #
The read timestamp at which the remove was observed. Greater or equal to the `commit_time` of the change/delete/remove.
drDocument :: Lens' DocumentRemove (Maybe Text) Source #
The resource name of the Document that has gone out of view.
drRemovedTargetIds :: Lens' DocumentRemove [Int32] Source #
A set of target IDs for targets that previously matched this document.
GoogleFirestoreAdminV1IndexFieldArrayConfig
data GoogleFirestoreAdminV1IndexFieldArrayConfig Source #
Indicates that this field supports operations on `array_value`s.
ArrayConfigUnspecified |
|
Contains |
|
Instances
DocumentChange
data DocumentChange Source #
A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected.
See: documentChange
smart constructor.
Instances
documentChange :: DocumentChange Source #
Creates a value of DocumentChange
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dcDocument :: Lens' DocumentChange (Maybe Document) Source #
The new state of the Document. If `mask` is set, contains only fields that were updated or added.
dcTargetIds :: Lens' DocumentChange [Int32] Source #
A set of target IDs of targets that match this document.
dcRemovedTargetIds :: Lens' DocumentChange [Int32] Source #
A set of target IDs for targets that no longer match this document.
GoogleFirestoreAdminV1FieldOperationMetadata
data GoogleFirestoreAdminV1FieldOperationMetadata Source #
Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.
See: googleFirestoreAdminV1FieldOperationMetadata
smart constructor.
Instances
googleFirestoreAdminV1FieldOperationMetadata :: GoogleFirestoreAdminV1FieldOperationMetadata Source #
Creates a value of GoogleFirestoreAdminV1FieldOperationMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfavfomProgressBytes :: Lens' GoogleFirestoreAdminV1FieldOperationMetadata (Maybe GoogleFirestoreAdminV1Progress) Source #
The progress, in bytes, of this operation.
gfavfomState :: Lens' GoogleFirestoreAdminV1FieldOperationMetadata (Maybe GoogleFirestoreAdminV1FieldOperationMetadataState) Source #
The state of the operation.
gfavfomField :: Lens' GoogleFirestoreAdminV1FieldOperationMetadata (Maybe Text) Source #
The field resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
gfavfomStartTime :: Lens' GoogleFirestoreAdminV1FieldOperationMetadata (Maybe UTCTime) Source #
The time this operation started.
gfavfomProgressDocuments :: Lens' GoogleFirestoreAdminV1FieldOperationMetadata (Maybe GoogleFirestoreAdminV1Progress) Source #
The progress, in documents, of this operation.
gfavfomIndexConfigDeltas :: Lens' GoogleFirestoreAdminV1FieldOperationMetadata [GoogleFirestoreAdminV1IndexConfigDelta] Source #
A list of IndexConfigDelta, which describe the intent of this operation.
gfavfomEndTime :: Lens' GoogleFirestoreAdminV1FieldOperationMetadata (Maybe UTCTime) Source #
The time this operation completed. Will be unset if operation still in progress.
GoogleFirestoreAdminV1ListIndexesResponse
data GoogleFirestoreAdminV1ListIndexesResponse Source #
The response for FirestoreAdmin.ListIndexes.
See: googleFirestoreAdminV1ListIndexesResponse
smart constructor.
Instances
googleFirestoreAdminV1ListIndexesResponse :: GoogleFirestoreAdminV1ListIndexesResponse Source #
Creates a value of GoogleFirestoreAdminV1ListIndexesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfavlirNextPageToken :: Lens' GoogleFirestoreAdminV1ListIndexesResponse (Maybe Text) Source #
A page token that may be used to request another page of results. If blank, this is the last page.
gfavlirIndexes :: Lens' GoogleFirestoreAdminV1ListIndexesResponse [GoogleFirestoreAdminV1Index] Source #
The requested indexes.
MapValue
A map value.
See: mapValue
smart constructor.
Instances
Eq MapValue Source # | |
Data MapValue Source # | |
Defined in Network.Google.FireStore.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MapValue -> c MapValue # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MapValue # toConstr :: MapValue -> Constr # dataTypeOf :: MapValue -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MapValue) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MapValue) # gmapT :: (forall b. Data b => b -> b) -> MapValue -> MapValue # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MapValue -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MapValue -> r # gmapQ :: (forall d. Data d => d -> u) -> MapValue -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> MapValue -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> MapValue -> m MapValue # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MapValue -> m MapValue # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MapValue -> m MapValue # | |
Show MapValue Source # | |
Generic MapValue Source # | |
ToJSON MapValue Source # | |
Defined in Network.Google.FireStore.Types.Product | |
FromJSON MapValue Source # | |
type Rep MapValue Source # | |
Defined in Network.Google.FireStore.Types.Product type Rep MapValue = D1 (MetaData "MapValue" "Network.Google.FireStore.Types.Product" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" True) (C1 (MetaCons "MapValue'" PrefixI True) (S1 (MetaSel (Just "_mvFields") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe MapValueFields)))) |
mvFields :: Lens' MapValue (Maybe MapValueFields) Source #
The map's fields. The map keys represent field names. Field names matching the regular expression `.*` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
BatchGetDocumentsRequest
data BatchGetDocumentsRequest Source #
The request for Firestore.BatchGetDocuments.
See: batchGetDocumentsRequest
smart constructor.
Instances
batchGetDocumentsRequest :: BatchGetDocumentsRequest Source #
Creates a value of BatchGetDocumentsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bReadTime :: Lens' BatchGetDocumentsRequest (Maybe UTCTime) Source #
Reads documents as they were at the given time. This may not be older than 60 seconds.
bNewTransaction :: Lens' BatchGetDocumentsRequest (Maybe TransactionOptions) Source #
Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
bTransaction :: Lens' BatchGetDocumentsRequest (Maybe ByteString) Source #
Reads documents in a transaction.
bDocuments :: Lens' BatchGetDocumentsRequest [Text] Source #
The names of the documents to retrieve. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided.
bMask :: Lens' BatchGetDocumentsRequest (Maybe DocumentMask) Source #
The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
Document
A Firestore document. Must not exceed 1 MiB - 4 bytes.
See: document
smart constructor.
Instances
Creates a value of Document
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dUpdateTime :: Lens' Document (Maybe UTCTime) Source #
Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query.
dName :: Lens' Document (Maybe Text) Source #
The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
dCreateTime :: Lens' Document (Maybe UTCTime) Source #
Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
dFields :: Lens' Document (Maybe DocumentFields) Source #
The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `.*` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
GoogleFirestoreAdminV1IndexOperationMetadataState
data GoogleFirestoreAdminV1IndexOperationMetadataState Source #
The state of the operation.
OperationStateUnspecified |
|
Initializing |
|
Processing |
|
Cancelling |
|
Finalizing |
|
Successful |
|
Failed |
|
Cancelled |
|
Instances
ArrayValue
data ArrayValue Source #
An array value.
See: arrayValue
smart constructor.
Instances
arrayValue :: ArrayValue Source #
Creates a value of ArrayValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Xgafv
V1 error format.
Instances
CommitResponse
data CommitResponse Source #
The response for Firestore.Commit.
See: commitResponse
smart constructor.
Instances
commitResponse :: CommitResponse Source #
Creates a value of CommitResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crCommitTime :: Lens' CommitResponse (Maybe UTCTime) Source #
The time at which the commit occurred.
crWriteResults :: Lens' CommitResponse [WriteResult] Source #
The result of applying the writes. This i-th write result corresponds to the i-th write in the request.
ListenResponse
data ListenResponse Source #
The response for Firestore.Listen.
See: listenResponse
smart constructor.
Instances
listenResponse :: ListenResponse Source #
Creates a value of ListenResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrTargetChange :: Lens' ListenResponse (Maybe TargetChange) Source #
Targets have changed.
lrDocumentRemove :: Lens' ListenResponse (Maybe DocumentRemove) Source #
A Document has been removed from a target (because it is no longer relevant to that target).
lrDocumentChange :: Lens' ListenResponse (Maybe DocumentChange) Source #
A Document has changed.
lrFilter :: Lens' ListenResponse (Maybe ExistenceFilter) Source #
A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown.
lrDocumentDelete :: Lens' ListenResponse (Maybe DocumentDelete) Source #
A Document has been deleted.
FieldFilter
data FieldFilter Source #
A filter on a specific field.
See: fieldFilter
smart constructor.
Instances
fieldFilter :: FieldFilter Source #
Creates a value of FieldFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ffOp :: Lens' FieldFilter (Maybe FieldFilterOp) Source #
The operator to filter by.
ffField :: Lens' FieldFilter (Maybe FieldReference) Source #
The field to filter by.
GoogleLongrunningOperationResponse
data GoogleLongrunningOperationResponse Source #
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
See: googleLongrunningOperationResponse
smart constructor.
Instances
googleLongrunningOperationResponse Source #
Creates a value of GoogleLongrunningOperationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
glorAddtional :: Lens' GoogleLongrunningOperationResponse (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
ListDocumentsResponse
data ListDocumentsResponse Source #
The response for Firestore.ListDocuments.
See: listDocumentsResponse
smart constructor.
Instances
listDocumentsResponse :: ListDocumentsResponse Source #
Creates a value of ListDocumentsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldrNextPageToken :: Lens' ListDocumentsResponse (Maybe Text) Source #
The next page token.
ldrDocuments :: Lens' ListDocumentsResponse [Document] Source #
The Documents found.
GoogleFirestoreAdminV1ExportDocumentsResponse
data GoogleFirestoreAdminV1ExportDocumentsResponse Source #
Returned in the google.longrunning.Operation response field.
See: googleFirestoreAdminV1ExportDocumentsResponse
smart constructor.
Instances
googleFirestoreAdminV1ExportDocumentsResponse :: GoogleFirestoreAdminV1ExportDocumentsResponse Source #
Creates a value of GoogleFirestoreAdminV1ExportDocumentsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gOutputURIPrefix :: Lens' GoogleFirestoreAdminV1ExportDocumentsResponse (Maybe Text) Source #
Location of the output files. This can be used to begin an import into Cloud Firestore (this project or another project) after the operation completes successfully.
FieldFilterOp
data FieldFilterOp Source #
The operator to filter by.
FFOOperatorUnspecified |
|
FFOLessThan |
|
FFOLessThanOrEqual |
|
FFOGreaterThan |
|
FFOGreaterThanOrEqual |
|
FFOEqual |
|
FFOArrayContains |
|
Instances
Projection
data Projection Source #
The projection of document's fields to return.
See: projection
smart constructor.
Instances
projection :: Projection Source #
Creates a value of Projection
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pFields :: Lens' Projection [FieldReference] Source #
The fields to return. If empty, all fields are returned. To only return the name of the document, use `['name']`.
Filter
A filter.
See: filter'
smart constructor.
Instances
Eq Filter Source # | |
Data Filter Source # | |
Defined in Network.Google.FireStore.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Filter -> c Filter # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Filter # toConstr :: Filter -> Constr # dataTypeOf :: Filter -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Filter) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Filter) # gmapT :: (forall b. Data b => b -> b) -> Filter -> Filter # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Filter -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Filter -> r # gmapQ :: (forall d. Data d => d -> u) -> Filter -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Filter -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Filter -> m Filter # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Filter -> m Filter # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Filter -> m Filter # | |
Show Filter Source # | |
Generic Filter Source # | |
ToJSON Filter Source # | |
Defined in Network.Google.FireStore.Types.Product | |
FromJSON Filter Source # | |
type Rep Filter Source # | |
Defined in Network.Google.FireStore.Types.Product type Rep Filter = D1 (MetaData "Filter" "Network.Google.FireStore.Types.Product" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "Filter'" PrefixI True) (S1 (MetaSel (Just "_fCompositeFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CompositeFilter)) :*: (S1 (MetaSel (Just "_fFieldFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe FieldFilter)) :*: S1 (MetaSel (Just "_fUnaryFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UnaryFilter))))) |
Creates a value of Filter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fCompositeFilter :: Lens' Filter (Maybe CompositeFilter) Source #
A composite filter.
fFieldFilter :: Lens' Filter (Maybe FieldFilter) Source #
A filter on a document field.
fUnaryFilter :: Lens' Filter (Maybe UnaryFilter) Source #
A filter that takes exactly one argument.
TargetChangeTargetChangeType
data TargetChangeTargetChangeType Source #
The type of change that occurred.
TCTCTNoChange |
|
TCTCTAdd |
|
TCTCTRemove |
|
TCTCTCurrent |
|
TCTCTReset |
|
Instances
GoogleFirestoreAdminV1IndexOperationMetadata
data GoogleFirestoreAdminV1IndexOperationMetadata Source #
Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex.
See: googleFirestoreAdminV1IndexOperationMetadata
smart constructor.
Instances
googleFirestoreAdminV1IndexOperationMetadata :: GoogleFirestoreAdminV1IndexOperationMetadata Source #
Creates a value of GoogleFirestoreAdminV1IndexOperationMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfaviomProgressBytes :: Lens' GoogleFirestoreAdminV1IndexOperationMetadata (Maybe GoogleFirestoreAdminV1Progress) Source #
The progress, in bytes, of this operation.
gfaviomState :: Lens' GoogleFirestoreAdminV1IndexOperationMetadata (Maybe GoogleFirestoreAdminV1IndexOperationMetadataState) Source #
The state of the operation.
gfaviomStartTime :: Lens' GoogleFirestoreAdminV1IndexOperationMetadata (Maybe UTCTime) Source #
The time this operation started.
gfaviomProgressDocuments :: Lens' GoogleFirestoreAdminV1IndexOperationMetadata (Maybe GoogleFirestoreAdminV1Progress) Source #
The progress, in documents, of this operation.
gfaviomEndTime :: Lens' GoogleFirestoreAdminV1IndexOperationMetadata (Maybe UTCTime) Source #
The time this operation completed. Will be unset if operation still in progress.
gfaviomIndex :: Lens' GoogleFirestoreAdminV1IndexOperationMetadata (Maybe Text) Source #
The index resource that this operation is acting on. For example: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
LocationLabels
data LocationLabels Source #
Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
See: locationLabels
smart constructor.
Instances
Creates a value of LocationLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ListenRequest
data ListenRequest Source #
A request for Firestore.Listen
See: listenRequest
smart constructor.
Instances
listenRequest :: ListenRequest Source #
Creates a value of ListenRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrRemoveTarget :: Lens' ListenRequest (Maybe Int32) Source #
The ID of a target to remove from this stream.
lrLabels :: Lens' ListenRequest (Maybe ListenRequestLabels) Source #
Labels associated with this target change.
lrAddTarget :: Lens' ListenRequest (Maybe Target) Source #
A target to add to this stream.
GoogleFirestoreAdminV1ImportDocumentsMetadataOperationState
data GoogleFirestoreAdminV1ImportDocumentsMetadataOperationState Source #
The state of the import operation.
GFAVIDMOSOperationStateUnspecified |
|
GFAVIDMOSInitializing |
|
GFAVIDMOSProcessing |
|
GFAVIDMOSCancelling |
|
GFAVIDMOSFinalizing |
|
GFAVIDMOSSuccessful |
|
GFAVIDMOSFailed |
|
GFAVIDMOSCancelled |
|
Instances
CommitRequest
data CommitRequest Source #
The request for Firestore.Commit.
See: commitRequest
smart constructor.
Instances
commitRequest :: CommitRequest Source #
Creates a value of CommitRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crTransaction :: Lens' CommitRequest (Maybe ByteString) Source #
If set, applies all writes in this transaction, and commits it.
crWrites :: Lens' CommitRequest [Write] Source #
The writes to apply. Always executed atomically and in order.
LocationMetadata
data LocationMetadata Source #
Service-specific metadata. For example the available capacity at the given location.
See: locationMetadata
smart constructor.
Instances
Creates a value of LocationMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmAddtional :: Lens' LocationMetadata (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
GoogleLongrunningListOperationsResponse
data GoogleLongrunningListOperationsResponse Source #
The response message for Operations.ListOperations.
See: googleLongrunningListOperationsResponse
smart constructor.
Instances
googleLongrunningListOperationsResponse :: GoogleLongrunningListOperationsResponse Source #
Creates a value of GoogleLongrunningListOperationsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gllorNextPageToken :: Lens' GoogleLongrunningListOperationsResponse (Maybe Text) Source #
The standard List next-page token.
gllorOperations :: Lens' GoogleLongrunningListOperationsResponse [GoogleLongrunningOperation] Source #
A list of operations that matches the specified filter in the request.
GoogleFirestoreAdminV1FieldOperationMetadataState
data GoogleFirestoreAdminV1FieldOperationMetadataState Source #
The state of the operation.
GFAVFOMSOperationStateUnspecified |
|
GFAVFOMSInitializing |
|
GFAVFOMSProcessing |
|
GFAVFOMSCancelling |
|
GFAVFOMSFinalizing |
|
GFAVFOMSSuccessful |
|
GFAVFOMSFailed |
|
GFAVFOMSCancelled |
|
Instances
CollectionSelector
data CollectionSelector Source #
A selection of a collection, such as `messages as m1`.
See: collectionSelector
smart constructor.
Instances
collectionSelector :: CollectionSelector Source #
Creates a value of CollectionSelector
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csAllDescendants :: Lens' CollectionSelector (Maybe Bool) Source #
When false, selects only collections that are immediate children of the `parent` specified in the containing `RunQueryRequest`. When true, selects all descendant collections.
csCollectionId :: Lens' CollectionSelector (Maybe Text) Source #
The collection ID. When set, selects only collections with this ID.
ListCollectionIdsRequest
data ListCollectionIdsRequest Source #
The request for Firestore.ListCollectionIds.
See: listCollectionIdsRequest
smart constructor.
Instances
listCollectionIdsRequest :: ListCollectionIdsRequest Source #
Creates a value of ListCollectionIdsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcirPageToken :: Lens' ListCollectionIdsRequest (Maybe Text) Source #
A page token. Must be a value from ListCollectionIdsResponse.
lcirPageSize :: Lens' ListCollectionIdsRequest (Maybe Int32) Source #
The maximum number of results to return.
WriteResponse
data WriteResponse Source #
The response for Firestore.Write.
See: writeResponse
smart constructor.
Instances
writeResponse :: WriteResponse Source #
Creates a value of WriteResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wStreamToken :: Lens' WriteResponse (Maybe ByteString) Source #
A token that represents the position of this response in the stream. This can be used by a client to resume the stream at this point. This field is always set.
wCommitTime :: Lens' WriteResponse (Maybe UTCTime) Source #
The time at which the commit occurred.
wWriteResults :: Lens' WriteResponse [WriteResult] Source #
The result of applying the writes. This i-th write result corresponds to the i-th write in the request.
wStreamId :: Lens' WriteResponse (Maybe Text) Source #
The ID of the stream. Only set on the first message, when a new stream was created.
Order
An order on a field.
See: order
smart constructor.
Instances
Eq Order Source # | |
Data Order Source # | |
Defined in Network.Google.FireStore.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Order -> c Order # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Order # dataTypeOf :: Order -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Order) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Order) # gmapT :: (forall b. Data b => b -> b) -> Order -> Order # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Order -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Order -> r # gmapQ :: (forall d. Data d => d -> u) -> Order -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Order -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Order -> m Order # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Order -> m Order # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Order -> m Order # | |
Show Order Source # | |
Generic Order Source # | |
ToJSON Order Source # | |
Defined in Network.Google.FireStore.Types.Product | |
FromJSON Order Source # | |
type Rep Order Source # | |
Defined in Network.Google.FireStore.Types.Product type Rep Order = D1 (MetaData "Order" "Network.Google.FireStore.Types.Product" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "Order'" PrefixI True) (S1 (MetaSel (Just "_oField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe FieldReference)) :*: S1 (MetaSel (Just "_oDirection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe OrderDirection)))) |
Creates a value of Order
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oDirection :: Lens' Order (Maybe OrderDirection) Source #
The direction to order by. Defaults to `ASCENDING`.
DocumentDelete
data DocumentDelete Source #
A Document has been deleted. May be the result of multiple writes, including updates, the last of which deleted the Document. Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected.
See: documentDelete
smart constructor.
Instances
documentDelete :: DocumentDelete Source #
Creates a value of DocumentDelete
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ddReadTime :: Lens' DocumentDelete (Maybe UTCTime) Source #
The read timestamp at which the delete was observed. Greater or equal to the `commit_time` of the delete.
ddDocument :: Lens' DocumentDelete (Maybe Text) Source #
The resource name of the Document that was deleted.
ddRemovedTargetIds :: Lens' DocumentDelete [Int32] Source #
A set of target IDs for targets that previously matched this entity.
FieldTransform
data FieldTransform Source #
A transformation of a field of the document.
See: fieldTransform
smart constructor.
Instances
fieldTransform :: FieldTransform Source #
Creates a value of FieldTransform
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ftFieldPath :: Lens' FieldTransform (Maybe Text) Source #
The path of the field. See Document.fields for the field path syntax reference.
ftAppendMissingElements :: Lens' FieldTransform (Maybe ArrayValue) Source #
Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value.
ftSetToServerValue :: Lens' FieldTransform (Maybe FieldTransformSetToServerValue) Source #
Sets the field to the given server value.
ftRemoveAllFromArray :: Lens' FieldTransform (Maybe ArrayValue) Source #
Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value.
MapValueFields
data MapValueFields Source #
The map's fields. The map keys represent field names. Field names matching the regular expression `.*` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
See: mapValueFields
smart constructor.
Instances
Creates a value of MapValueFields
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
DocumentFields
data DocumentFields Source #
The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `.*` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
See: documentFields
smart constructor.
Instances
Creates a value of DocumentFields
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ReadOnly
Options for a transaction that can only be used to read documents.
See: readOnly
smart constructor.
Instances
Eq ReadOnly Source # | |
Data ReadOnly Source # | |
Defined in Network.Google.FireStore.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReadOnly -> c ReadOnly # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReadOnly # toConstr :: ReadOnly -> Constr # dataTypeOf :: ReadOnly -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ReadOnly) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReadOnly) # gmapT :: (forall b. Data b => b -> b) -> ReadOnly -> ReadOnly # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReadOnly -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReadOnly -> r # gmapQ :: (forall d. Data d => d -> u) -> ReadOnly -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ReadOnly -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReadOnly -> m ReadOnly # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReadOnly -> m ReadOnly # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReadOnly -> m ReadOnly # | |
Show ReadOnly Source # | |
Generic ReadOnly Source # | |
ToJSON ReadOnly Source # | |
Defined in Network.Google.FireStore.Types.Product | |
FromJSON ReadOnly Source # | |
type Rep ReadOnly Source # | |
Defined in Network.Google.FireStore.Types.Product |
Creates a value of ReadOnly
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
roReadTime :: Lens' ReadOnly (Maybe UTCTime) Source #
Reads documents at the given time. This may not be older than 60 seconds.
Target
A specification of a set of documents to listen to.
See: target
smart constructor.
Instances
Creates a value of Target
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tTargetId :: Lens' Target (Maybe Int32) Source #
A client provided target ID. If not set, the server will assign an ID for the target. Used for resuming a target without changing IDs. The IDs can either be client-assigned or be server-assigned in a previous stream. All targets with client provided IDs must be added before adding a target that needs a server-assigned id.
tOnce :: Lens' Target (Maybe Bool) Source #
If the target should be removed once it is current and consistent.
tReadTime :: Lens' Target (Maybe UTCTime) Source #
Start listening after a specific `read_time`. The client must know the state of matching documents at this time.
tResumeToken :: Lens' Target (Maybe ByteString) Source #
A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail.
tDocuments :: Lens' Target (Maybe DocumentsTarget) Source #
A target specified by a set of document names.
WriteRequestLabels
data WriteRequestLabels Source #
Labels associated with this write request.
See: writeRequestLabels
smart constructor.
Instances
Creates a value of WriteRequestLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
FieldTransformSetToServerValue
data FieldTransformSetToServerValue Source #
Sets the field to the given server value.
ServerValueUnspecified |
|
RequestTime |
|
Instances
GoogleLongrunningOperation
data GoogleLongrunningOperation Source #
This resource represents a long-running operation that is the result of a network API call.
See: googleLongrunningOperation
smart constructor.
Instances
googleLongrunningOperation :: GoogleLongrunningOperation Source #
Creates a value of GoogleLongrunningOperation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gloDone :: Lens' GoogleLongrunningOperation (Maybe Bool) Source #
If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
gloError :: Lens' GoogleLongrunningOperation (Maybe Status) Source #
The error result of the operation in case of failure or cancellation.
gloResponse :: Lens' GoogleLongrunningOperation (Maybe GoogleLongrunningOperationResponse) Source #
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
gloName :: Lens' GoogleLongrunningOperation (Maybe Text) Source #
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
gloMetadata :: Lens' GoogleLongrunningOperation (Maybe GoogleLongrunningOperationMetadata) Source #
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
GoogleFirestoreAdminV1ExportDocumentsMetadataOperationState
data GoogleFirestoreAdminV1ExportDocumentsMetadataOperationState Source #
The state of the export operation.
GFAVEDMOSOperationStateUnspecified |
|
GFAVEDMOSInitializing |
|
GFAVEDMOSProcessing |
|
GFAVEDMOSCancelling |
|
GFAVEDMOSFinalizing |
|
GFAVEDMOSSuccessful |
|
GFAVEDMOSFailed |
|
GFAVEDMOSCancelled |
|
Instances
UnaryFilter
data UnaryFilter Source #
A filter with a single operand.
See: unaryFilter
smart constructor.
Instances
unaryFilter :: UnaryFilter Source #
Creates a value of UnaryFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ufOp :: Lens' UnaryFilter (Maybe UnaryFilterOp) Source #
The unary operator to apply.
ufField :: Lens' UnaryFilter (Maybe FieldReference) Source #
The field to which to apply the operator.