Network.Google.Resource.FireStore.Projects.Databases.Documents.List

Lists documents.

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

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)))))))))))))))

A resource alias for firestore.projects.databases.documents.list method which the ProjectsDatabasesDocumentsList request conforms to.

Creating a Request

projectsDatabasesDocumentsList

Arguments

:: Text

pParent

-> Text

pCollectionId

-> ProjectsDatabasesDocumentsList

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:

• pParent
• pXgafv
• pReadTime
• pUploadProtocol
• pOrderBy
• pAccessToken
• pCollectionId
• pUploadType
• pTransaction
• pShowMissing
• pPageToken
• pPageSize
• pMaskFieldPaths
• pCallback

data ProjectsDatabasesDocumentsList

Lists documents.

See: projectsDatabasesDocumentsList smart constructor.

Instances

Eq ProjectsDatabasesDocumentsList

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.List

Methods

(==) :: ProjectsDatabasesDocumentsList -> ProjectsDatabasesDocumentsList -> Bool

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

Data ProjectsDatabasesDocumentsList

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.List

Methods

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

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

toConstr :: ProjectsDatabasesDocumentsList -> Constr

dataTypeOf :: ProjectsDatabasesDocumentsList -> DataType

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

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

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

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

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

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

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

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

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

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

Show ProjectsDatabasesDocumentsList

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.List

Methods

showsPrec :: Int -> ProjectsDatabasesDocumentsList -> ShowS

show :: ProjectsDatabasesDocumentsList -> String

showList :: [ProjectsDatabasesDocumentsList] -> ShowS

Generic ProjectsDatabasesDocumentsList

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.List

Associated Types

type Rep ProjectsDatabasesDocumentsList :: Type -> Type

Methods

from :: ProjectsDatabasesDocumentsList -> Rep ProjectsDatabasesDocumentsList x

to :: Rep ProjectsDatabasesDocumentsList x -> ProjectsDatabasesDocumentsList

GoogleRequest ProjectsDatabasesDocumentsList

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.List

Associated Types

type Rs ProjectsDatabasesDocumentsList :: Type

type Scopes ProjectsDatabasesDocumentsList :: [Symbol]

Methods

requestClient :: ProjectsDatabasesDocumentsList -> GClient (Rs ProjectsDatabasesDocumentsList)

type Rep ProjectsDatabasesDocumentsList

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.List

type Rep ProjectsDatabasesDocumentsList = D1 (MetaData "ProjectsDatabasesDocumentsList" "Network.Google.Resource.FireStore.Projects.Databases.Documents.List" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "ProjectsDatabasesDocumentsList'" PrefixI True) (((S1 (MetaSel (Just "_pParent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_pXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_pReadTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime')))) :*: ((S1 (MetaSel (Just "_pUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_pAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pCollectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) :*: ((S1 (MetaSel (Just "_pUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pTransaction") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bytes)) :*: S1 (MetaSel (Just "_pShowMissing") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 (MetaSel (Just "_pPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) :*: (S1 (MetaSel (Just "_pMaskFieldPaths") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_pCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Scopes ProjectsDatabasesDocumentsList

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.List

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

type Rs ProjectsDatabasesDocumentsList

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.List

type Rs ProjectsDatabasesDocumentsList = ListDocumentsResponse

Request Lenses

pParent :: Lens' ProjectsDatabasesDocumentsList Text

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`

pXgafv :: Lens' ProjectsDatabasesDocumentsList (Maybe Xgafv)

V1 error format.

pReadTime :: Lens' ProjectsDatabasesDocumentsList (Maybe UTCTime)

Reads documents as they were at the given time. This may not be older than 60 seconds.

pUploadProtocol :: Lens' ProjectsDatabasesDocumentsList (Maybe Text)

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

pOrderBy :: Lens' ProjectsDatabasesDocumentsList (Maybe Text)

The order to sort results by. For example: `priority desc, name`.

pAccessToken :: Lens' ProjectsDatabasesDocumentsList (Maybe Text)

OAuth access token.

pCollectionId :: Lens' ProjectsDatabasesDocumentsList Text

The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.

pUploadType :: Lens' ProjectsDatabasesDocumentsList (Maybe Text)

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

pTransaction :: Lens' ProjectsDatabasesDocumentsList (Maybe ByteString)

Reads documents in a transaction.

pShowMissing :: Lens' ProjectsDatabasesDocumentsList (Maybe Bool)

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)

The `next_page_token` value returned from a previous List request, if any.

pPageSize :: Lens' ProjectsDatabasesDocumentsList (Maybe Int32)

The maximum number of documents to return.

pMaskFieldPaths :: Lens' ProjectsDatabasesDocumentsList [Text]

The list of field paths in the mask. See Document.fields for a field path syntax reference.

pCallback :: Lens' ProjectsDatabasesDocumentsList (Maybe Text)

JSONP