Firestore.Projects.Databases.Documents.List (Cloud Firestore API v1 (Rev. 25) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.firestore.v1.FirestoreRequest<ListDocumentsResponse>
        
        com.google.api.services.firestore.v1.Firestore.Projects.Databases.Documents.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Firestore.Projects.Databases.Documents
```
public class Firestore.Projects.Databases.Documents.List
extends FirestoreRequest<ListDocumentsResponse>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(java.lang.String parent, java.lang.String collectionId)
Lists documents.

Constructors
Modifier	Constructor and Description
`protected`	`List(java.lang.String parent, java.lang.String collectionId)` Lists documents.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.String`	`getCollectionId()` Required.
`java.util.List<java.lang.String>`	`getMaskFieldPaths()` The list of field paths in the mask.
`java.lang.String`	`getOrderBy()` The order to sort results by.
`java.lang.Integer`	`getPageSize()` The maximum number of documents to return.
`java.lang.String`	`getPageToken()` The `next_page_token` value returned from a previous List request, if any.
`java.lang.String`	`getParent()` Required.
`java.lang.String`	`getReadTime()` Reads documents as they were at the given time.
`java.lang.Boolean`	`getShowMissing()` If the list should show missing documents.
`java.lang.String`	`getTransaction()` Reads documents in a transaction.
`Firestore.Projects.Databases.Documents.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`Firestore.Projects.Databases.Documents.List`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`Firestore.Projects.Databases.Documents.List`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`Firestore.Projects.Databases.Documents.List`	`setAlt(java.lang.String alt)` Data format for response.
`Firestore.Projects.Databases.Documents.List`	`setCallback(java.lang.String callback)` JSONP
`Firestore.Projects.Databases.Documents.List`	`setCollectionId(java.lang.String collectionId)` Required.
`Firestore.Projects.Databases.Documents.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Firestore.Projects.Databases.Documents.List`	`setKey(java.lang.String key)` API key.
`Firestore.Projects.Databases.Documents.List`	`setMaskFieldPaths(java.util.List<java.lang.String> maskFieldPaths)` The list of field paths in the mask.
`Firestore.Projects.Databases.Documents.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Firestore.Projects.Databases.Documents.List`	`setOrderBy(java.lang.String orderBy)` The order to sort results by.
`Firestore.Projects.Databases.Documents.List`	`setPageSize(java.lang.Integer pageSize)` The maximum number of documents to return.
`Firestore.Projects.Databases.Documents.List`	`setPageToken(java.lang.String pageToken)` The `next_page_token` value returned from a previous List request, if any.
`Firestore.Projects.Databases.Documents.List`	`setParent(java.lang.String parent)` Required.
`Firestore.Projects.Databases.Documents.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Firestore.Projects.Databases.Documents.List`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Firestore.Projects.Databases.Documents.List`	`setReadTime(java.lang.String readTime)` Reads documents as they were at the given time.
`Firestore.Projects.Databases.Documents.List`	`setShowMissing(java.lang.Boolean showMissing)` If the list should show missing documents.
`Firestore.Projects.Databases.Documents.List`	`setTransaction(java.lang.String transaction)` Reads documents in a transaction.
`Firestore.Projects.Databases.Documents.List`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`Firestore.Projects.Databases.Documents.List`	`setUploadType(java.lang.String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.firestore.v1.FirestoreRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List(java.lang.String parent,
               java.lang.String collectionId)
```
    Lists documents. Create a request for the method "documents.list". This request holds the parameters needed by the the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Firestore.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    parent - Required. 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`
    
    collectionId - Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListDocumentsResponse>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListDocumentsResponse>
    
    Throws:
    
    java.io.IOException
  - set$Xgafv
```
public Firestore.Projects.Databases.Documents.List set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: FirestoreRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class FirestoreRequest<ListDocumentsResponse>
  - setAccessToken
```
public Firestore.Projects.Databases.Documents.List setAccessToken(java.lang.String accessToken)
```
    Description copied from class: FirestoreRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class FirestoreRequest<ListDocumentsResponse>
  - setAlt
```
public Firestore.Projects.Databases.Documents.List setAlt(java.lang.String alt)
```
    Description copied from class: FirestoreRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class FirestoreRequest<ListDocumentsResponse>
  - setCallback
```
public Firestore.Projects.Databases.Documents.List setCallback(java.lang.String callback)
```
    Description copied from class: FirestoreRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class FirestoreRequest<ListDocumentsResponse>
  - setFields
```
public Firestore.Projects.Databases.Documents.List setFields(java.lang.String fields)
```
    Description copied from class: FirestoreRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class FirestoreRequest<ListDocumentsResponse>
  - setKey
```
public Firestore.Projects.Databases.Documents.List setKey(java.lang.String key)
```
    Description copied from class: FirestoreRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class FirestoreRequest<ListDocumentsResponse>
  - setOauthToken
```
public Firestore.Projects.Databases.Documents.List setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: FirestoreRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class FirestoreRequest<ListDocumentsResponse>
  - setPrettyPrint
```
public Firestore.Projects.Databases.Documents.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: FirestoreRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class FirestoreRequest<ListDocumentsResponse>
  - setQuotaUser
```
public Firestore.Projects.Databases.Documents.List setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: FirestoreRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class FirestoreRequest<ListDocumentsResponse>
  - setUploadType
```
public Firestore.Projects.Databases.Documents.List setUploadType(java.lang.String uploadType)
```
    Description copied from class: FirestoreRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class FirestoreRequest<ListDocumentsResponse>
  - setUploadProtocol
```
public Firestore.Projects.Databases.Documents.List setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: FirestoreRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class FirestoreRequest<ListDocumentsResponse>
  - getParent
```
public java.lang.String getParent()
```
    Required. 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`
  - setParent
```
public Firestore.Projects.Databases.Documents.List setParent(java.lang.String parent)
```
    Required. 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`
  - getCollectionId
```
public java.lang.String getCollectionId()
```
    Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.
  - setCollectionId
```
public Firestore.Projects.Databases.Documents.List setCollectionId(java.lang.String collectionId)
```
    Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.
  - getTransaction
```
public java.lang.String getTransaction()
```
    Reads documents in a transaction.
  - setTransaction
```
public Firestore.Projects.Databases.Documents.List setTransaction(java.lang.String transaction)
```
    Reads documents in a transaction.
  - getReadTime
```
public java.lang.String getReadTime()
```
    Reads documents as they were at the given time. This may not be older than 60 seconds.
  - setReadTime
```
public Firestore.Projects.Databases.Documents.List setReadTime(java.lang.String readTime)
```
    Reads documents as they were at the given time. This may not be older than 60 seconds.
  - getOrderBy
```
public java.lang.String getOrderBy()
```
    The order to sort results by. For example: `priority desc, name`.
  - setOrderBy
```
public Firestore.Projects.Databases.Documents.List setOrderBy(java.lang.String orderBy)
```
    The order to sort results by. For example: `priority desc, name`.
  - getShowMissing
```
public java.lang.Boolean getShowMissing()
```
    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`.
  - setShowMissing
```
public Firestore.Projects.Databases.Documents.List setShowMissing(java.lang.Boolean showMissing)
```
    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`.
  - getPageToken
```
public java.lang.String getPageToken()
```
    The `next_page_token` value returned from a previous List request, if any.
  - setPageToken
```
public Firestore.Projects.Databases.Documents.List setPageToken(java.lang.String pageToken)
```
    The `next_page_token` value returned from a previous List request, if any.
  - getMaskFieldPaths
```
public java.util.List<java.lang.String> getMaskFieldPaths()
```
    The list of field paths in the mask. See Document.fields for a field path syntax reference.
  - setMaskFieldPaths
```
public Firestore.Projects.Databases.Documents.List setMaskFieldPaths(java.util.List<java.lang.String> maskFieldPaths)
```
    The list of field paths in the mask. See Document.fields for a field path syntax reference.
  - getPageSize
```
public java.lang.Integer getPageSize()
```
    The maximum number of documents to return.
  - setPageSize
```
public Firestore.Projects.Databases.Documents.List setPageSize(java.lang.Integer pageSize)
```
    The maximum number of documents to return.
  - set
```
public Firestore.Projects.Databases.Documents.List set(java.lang.String parameterName,
                                                       java.lang.Object value)
```
    Overrides:
    
    set in class FirestoreRequest<ListDocumentsResponse>

Cloud Firestore API v1 (revision 25)

Class Firestore.Projects.Databases.Documents.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.firestore.v1.FirestoreRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getParent

setParent

getCollectionId

setCollectionId

getTransaction

setTransaction

getReadTime

setReadTime

getOrderBy

setOrderBy

getShowMissing

setShowMissing

getPageToken

setPageToken

getMaskFieldPaths

setMaskFieldPaths

getPageSize

setPageSize

set