GoogleApi.Firestore.V1.Api.Projects.firestore_projects_databases_documents_list
You're seeing just the function
firestore_projects_databases_documents_list
, go back to GoogleApi.Firestore.V1.Api.Projects module for more information.
Link to this function
firestore_projects_databases_documents_list(connection, parent, collection_id, optional_params \\ [], opts \\ [])
View SourceSpecs
firestore_projects_databases_documents_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.ListDocumentsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists documents.
Parameters
-
connection
(type:GoogleApi.Firestore.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent resource name. In the format:projects/{project_id}/databases/{database_id}/documents
orprojects/{project_id}/databases/{database_id}/documents/{document_path}
. For example:projects/my-project/databases/my-database/documents
orprojects/my-project/databases/my-database/documents/chatrooms/my-chatroom
-
collection_id
(type:String.t
) - Required. The collection ID, relative toparent
, to list. For example:chatrooms
ormessages
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"mask.fieldPaths"
(type:list(String.t)
) - The list of field paths in the mask. See Document.fields for a field path syntax reference. -
:orderBy
(type:String.t
) - The order to sort results by. For example:priority desc, name
. -
:pageSize
(type:integer()
) - The maximum number of documents to return. -
:pageToken
(type:String.t
) - Thenext_page_token
value returned from a previous List request, if any. -
:readTime
(type:DateTime.t
) - Reads documents as they were at the given time. This may not be older than 270 seconds. -
:showMissing
(type:boolean()
) - 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 withshow_missing
may not specifywhere
ororder_by
. -
:transaction
(type:String.t
) - Reads documents in a transaction.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Firestore.V1.Model.ListDocumentsResponse{}}
on success -
{:error, info}
on failure