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 |
Lists documents.
See: Cloud Firestore API Reference for firestore.projects.databases.documents.list
.
Synopsis
- type ProjectsDatabasesDocumentsListResource = "v1" :> (Capture "parent" Text :> (Capture "collectionId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "readTime" DateTime' :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "transaction" Bytes :> (QueryParam "showMissing" Bool :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParams "mask.fieldPaths" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListDocumentsResponse)))))))))))))))
- projectsDatabasesDocumentsList :: Text -> Text -> ProjectsDatabasesDocumentsList
- data ProjectsDatabasesDocumentsList
- pParent :: Lens' ProjectsDatabasesDocumentsList Text
- pXgafv :: Lens' ProjectsDatabasesDocumentsList (Maybe Xgafv)
- pReadTime :: Lens' ProjectsDatabasesDocumentsList (Maybe UTCTime)
- pUploadProtocol :: Lens' ProjectsDatabasesDocumentsList (Maybe Text)
- pOrderBy :: Lens' ProjectsDatabasesDocumentsList (Maybe Text)
- pAccessToken :: Lens' ProjectsDatabasesDocumentsList (Maybe Text)
- pCollectionId :: Lens' ProjectsDatabasesDocumentsList Text
- pUploadType :: Lens' ProjectsDatabasesDocumentsList (Maybe Text)
- pTransaction :: Lens' ProjectsDatabasesDocumentsList (Maybe ByteString)
- pShowMissing :: Lens' ProjectsDatabasesDocumentsList (Maybe Bool)
- pPageToken :: Lens' ProjectsDatabasesDocumentsList (Maybe Text)
- pPageSize :: Lens' ProjectsDatabasesDocumentsList (Maybe Int32)
- pMaskFieldPaths :: Lens' ProjectsDatabasesDocumentsList [Text]
- pCallback :: Lens' ProjectsDatabasesDocumentsList (Maybe Text)
REST Resource
type ProjectsDatabasesDocumentsListResource = "v1" :> (Capture "parent" Text :> (Capture "collectionId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "readTime" DateTime' :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "transaction" Bytes :> (QueryParam "showMissing" Bool :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParams "mask.fieldPaths" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListDocumentsResponse))))))))))))))) Source #
A resource alias for firestore.projects.databases.documents.list
method which the
ProjectsDatabasesDocumentsList
request conforms to.
Creating a Request
projectsDatabasesDocumentsList Source #
Creates a value of ProjectsDatabasesDocumentsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ProjectsDatabasesDocumentsList Source #
Lists documents.
See: projectsDatabasesDocumentsList
smart constructor.
Instances
Request Lenses
pParent :: Lens' ProjectsDatabasesDocumentsList 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`
pReadTime :: Lens' ProjectsDatabasesDocumentsList (Maybe UTCTime) Source #
Reads documents as they were at the given time. This may not be older than 60 seconds.
pUploadProtocol :: Lens' ProjectsDatabasesDocumentsList (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
pOrderBy :: Lens' ProjectsDatabasesDocumentsList (Maybe Text) Source #
The order to sort results by. For example: `priority desc, name`.
pAccessToken :: Lens' ProjectsDatabasesDocumentsList (Maybe Text) Source #
OAuth access token.
pCollectionId :: Lens' ProjectsDatabasesDocumentsList Text Source #
The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.
pUploadType :: Lens' ProjectsDatabasesDocumentsList (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
pTransaction :: Lens' ProjectsDatabasesDocumentsList (Maybe ByteString) Source #
Reads documents in a transaction.
pShowMissing :: Lens' ProjectsDatabasesDocumentsList (Maybe Bool) Source #
If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set. Requests with `show_missing` may not specify `where` or `order_by`.
pPageToken :: Lens' ProjectsDatabasesDocumentsList (Maybe Text) Source #
The `next_page_token` value returned from a previous List request, if any.
pPageSize :: Lens' ProjectsDatabasesDocumentsList (Maybe Int32) Source #
The maximum number of documents to return.
pMaskFieldPaths :: Lens' ProjectsDatabasesDocumentsList [Text] Source #
The list of field paths in the mask. See Document.fields for a field path syntax reference.