com.google.api.services.firestore.v1

Class Firestore.Projects.Databases.Documents

java.lang.Object

com.google.api.services.firestore.v1.Firestore.Projects.Databases.Documents

Enclosing class:

Firestore.Projects.Databases

public class Firestore.Projects.Databases.Documents
extends java.lang.Object

The "documents" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Firestore.Projects.Databases.Documents.BatchGet
class	Firestore.Projects.Databases.Documents.BeginTransaction
class	Firestore.Projects.Databases.Documents.Commit
class	Firestore.Projects.Databases.Documents.CreateDocument
class	Firestore.Projects.Databases.Documents.Delete
class	Firestore.Projects.Databases.Documents.Get
class	Firestore.Projects.Databases.Documents.List
class	Firestore.Projects.Databases.Documents.ListCollectionIds
class	Firestore.Projects.Databases.Documents.Listen
class	Firestore.Projects.Databases.Documents.Patch
class	Firestore.Projects.Databases.Documents.Rollback
class	Firestore.Projects.Databases.Documents.RunQuery
class	Firestore.Projects.Databases.Documents.Write

Constructor Summary

Constructors

Constructor and Description
Documents()

Method Summary

Modifier and Type	Method and Description
Firestore.Projects.Databases.Documents.BatchGet	batchGet(java.lang.String database, BatchGetDocumentsRequest content) Gets multiple documents.
Firestore.Projects.Databases.Documents.BeginTransaction	beginTransaction(java.lang.String database, BeginTransactionRequest content) Starts a new transaction.
Firestore.Projects.Databases.Documents.Commit	commit(java.lang.String database, CommitRequest content) Commits a transaction, while optionally updating documents.
Firestore.Projects.Databases.Documents.CreateDocument	createDocument(java.lang.String parent, java.lang.String collectionId, Document content) Creates a new document.
Firestore.Projects.Databases.Documents.Delete	delete(java.lang.String name) Deletes a document.
Firestore.Projects.Databases.Documents.Get	get(java.lang.String name) Gets a single document.
Firestore.Projects.Databases.Documents.List	list(java.lang.String parent, java.lang.String collectionId) Lists documents.
Firestore.Projects.Databases.Documents.ListCollectionIds	listCollectionIds(java.lang.String parent, ListCollectionIdsRequest content) Lists all the collection IDs underneath a document.
Firestore.Projects.Databases.Documents.Listen	listen(java.lang.String database, ListenRequest content) Listens to changes.
Firestore.Projects.Databases.Documents.Patch	patch(java.lang.String name, Document content) Updates or inserts a document.
Firestore.Projects.Databases.Documents.Rollback	rollback(java.lang.String database, RollbackRequest content) Rolls back a transaction.
Firestore.Projects.Databases.Documents.RunQuery	runQuery(java.lang.String parent, RunQueryRequest content) Runs a query.
Firestore.Projects.Databases.Documents.Write	write(java.lang.String database, WriteRequest content) Streams batches of document updates and deletes, in order.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Documents

public Documents()

Method Detail

batchGet

public Firestore.Projects.Databases.Documents.BatchGet batchGet(java.lang.String database,
                                                                BatchGetDocumentsRequest content)
                                                         throws java.io.IOException

Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested. Create a request for the method "documents.batchGet". This request holds the parameters needed by the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

database - Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`.

content - the BatchGetDocumentsRequest

Returns:

the request

Throws:

java.io.IOException

beginTransaction

public Firestore.Projects.Databases.Documents.BeginTransaction beginTransaction(java.lang.String database,
                                                                                BeginTransactionRequest content)
                                                                         throws java.io.IOException

Starts a new transaction. Create a request for the method "documents.beginTransaction". This request holds the parameters needed by the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

database - Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`.

content - the BeginTransactionRequest

Returns:

the request

Throws:

java.io.IOException

commit

public Firestore.Projects.Databases.Documents.Commit commit(java.lang.String database,
                                                            CommitRequest content)
                                                     throws java.io.IOException

Commits a transaction, while optionally updating documents. Create a request for the method "documents.commit". This request holds the parameters needed by the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

database - Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`.

content - the CommitRequest

Returns:

the request

Throws:

java.io.IOException

createDocument

public Firestore.Projects.Databases.Documents.CreateDocument createDocument(java.lang.String parent,
                                                                            java.lang.String collectionId,
                                                                            Document content)
                                                                     throws java.io.IOException

Creates a new document. Create a request for the method "documents.createDocument". This request holds the parameters needed by the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`

collectionId - Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`.

content - the Document

Returns:

the request

Throws:

java.io.IOException

delete

public Firestore.Projects.Databases.Documents.Delete delete(java.lang.String name)
                                                     throws java.io.IOException

Deletes a document. Create a request for the method "documents.delete". This request holds the parameters needed by the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

Returns:

the request

Throws:

java.io.IOException

get

public Firestore.Projects.Databases.Documents.Get get(java.lang.String name)
                                               throws java.io.IOException

Gets a single document. Create a request for the method "documents.get". This request holds the parameters needed by the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

Returns:

the request

Throws:

java.io.IOException

list

public Firestore.Projects.Databases.Documents.List list(java.lang.String parent,
                                                        java.lang.String collectionId)
                                                 throws java.io.IOException

Lists documents. Create a request for the method "documents.list". This request holds the parameters needed by the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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`.

Returns:

the request

Throws:

java.io.IOException

listCollectionIds

public Firestore.Projects.Databases.Documents.ListCollectionIds listCollectionIds(java.lang.String parent,
                                                                                  ListCollectionIdsRequest content)
                                                                           throws java.io.IOException

Lists all the collection IDs underneath a document. Create a request for the method "documents.listCollectionIds". This request holds the parameters needed by the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

content - the ListCollectionIdsRequest

Returns:

the request

Throws:

java.io.IOException

listen

public Firestore.Projects.Databases.Documents.Listen listen(java.lang.String database,
                                                            ListenRequest content)
                                                     throws java.io.IOException

Listens to changes. Create a request for the method "documents.listen". This request holds the parameters needed by the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

database - Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`.

content - the ListenRequest

Returns:

the request

Throws:

java.io.IOException

patch

public Firestore.Projects.Databases.Documents.Patch patch(java.lang.String name,
                                                          Document content)
                                                   throws java.io.IOException

Updates or inserts a document. Create a request for the method "documents.patch". This request holds the parameters needed by the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

content - the Document

Returns:

the request

Throws:

java.io.IOException

rollback

public Firestore.Projects.Databases.Documents.Rollback rollback(java.lang.String database,
                                                                RollbackRequest content)
                                                         throws java.io.IOException

Rolls back a transaction. Create a request for the method "documents.rollback". This request holds the parameters needed by the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

database - Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`.

content - the RollbackRequest

Returns:

the request

Throws:

java.io.IOException

runQuery

public Firestore.Projects.Databases.Documents.RunQuery runQuery(java.lang.String parent,
                                                                RunQueryRequest content)
                                                         throws java.io.IOException

Runs a query. Create a request for the method "documents.runQuery". This request holds the parameters needed by the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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`

content - the RunQueryRequest

Returns:

the request

Throws:

java.io.IOException

write

public Firestore.Projects.Databases.Documents.Write write(java.lang.String database,
                                                          WriteRequest content)
                                                   throws java.io.IOException

Streams batches of document updates and deletes, in order. Create a request for the method "documents.write". This request holds the parameters needed by the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

database - Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message.

content - the WriteRequest

Returns:

the request

Throws:

java.io.IOException