@@ -94,6 +94,7 @@ class FirestoreAdminAsyncClient:
9494 FirestoreAdminClient .parse_common_location_path
9595 )
9696
97+ from_service_account_info = FirestoreAdminClient .from_service_account_info
9798 from_service_account_file = FirestoreAdminClient .from_service_account_file
9899 from_service_account_json = from_service_account_file
99100
@@ -175,18 +176,20 @@ async def create_index(
175176 [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].
176177
177178 Args:
178- request (:class:`~.firestore_admin .CreateIndexRequest`):
179+ request (:class:`google.cloud.firestore_admin_v1.types .CreateIndexRequest`):
179180 The request object. The request for
180181 [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
181182 parent (:class:`str`):
182183 Required. A parent name of the form
183184 ``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}``
185+
184186 This corresponds to the ``parent`` field
185187 on the ``request`` instance; if ``request`` is provided, this
186188 should not be set.
187- index (:class:`~.gfa_index .Index`):
189+ index (:class:`google.cloud.firestore_admin_v1.types .Index`):
188190 Required. The composite index to
189191 create.
192+
190193 This corresponds to the ``index`` field
191194 on the ``request`` instance; if ``request`` is provided, this
192195 should not be set.
@@ -198,13 +201,11 @@ async def create_index(
198201 sent along with the request as metadata.
199202
200203 Returns:
201- ~ .operation_async.AsyncOperation:
204+ google.api_core .operation_async.AsyncOperation:
202205 An object representing a long-running operation.
203206
204- The result type for the operation will be
205- :class:``~.gfa_index.Index``: Cloud Firestore indexes
206- enable simple and complex queries against documents in a
207- database.
207+ The result type for the operation will be :class:`google.cloud.firestore_admin_v1.types.Index` Cloud Firestore indexes enable simple and complex queries against
208+ documents in a database.
208209
209210 """
210211 # Create or coerce a protobuf request object.
@@ -267,12 +268,13 @@ async def list_indexes(
267268 r"""Lists composite indexes.
268269
269270 Args:
270- request (:class:`~.firestore_admin .ListIndexesRequest`):
271+ request (:class:`google.cloud.firestore_admin_v1.types .ListIndexesRequest`):
271272 The request object. The request for
272273 [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
273274 parent (:class:`str`):
274275 Required. A parent name of the form
275276 ``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}``
277+
276278 This corresponds to the ``parent`` field
277279 on the ``request`` instance; if ``request`` is provided, this
278280 should not be set.
@@ -284,7 +286,7 @@ async def list_indexes(
284286 sent along with the request as metadata.
285287
286288 Returns:
287- ~ .pagers.ListIndexesAsyncPager:
289+ google.cloud.firestore_admin_v1.services.firestore_admin .pagers.ListIndexesAsyncPager:
288290 The response for
289291 [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
290292
@@ -358,12 +360,13 @@ async def get_index(
358360 r"""Gets a composite index.
359361
360362 Args:
361- request (:class:`~.firestore_admin .GetIndexRequest`):
363+ request (:class:`google.cloud.firestore_admin_v1.types .GetIndexRequest`):
362364 The request object. The request for
363365 [FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex].
364366 name (:class:`str`):
365367 Required. A name of the form
366368 ``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}``
369+
367370 This corresponds to the ``name`` field
368371 on the ``request`` instance; if ``request`` is provided, this
369372 should not be set.
@@ -375,7 +378,7 @@ async def get_index(
375378 sent along with the request as metadata.
376379
377380 Returns:
378- ~.index .Index:
381+ google.cloud.firestore_admin_v1.types .Index:
379382 Cloud Firestore indexes enable simple
380383 and complex queries against documents in
381384 a database.
@@ -441,12 +444,13 @@ async def delete_index(
441444 r"""Deletes a composite index.
442445
443446 Args:
444- request (:class:`~.firestore_admin .DeleteIndexRequest`):
447+ request (:class:`google.cloud.firestore_admin_v1.types .DeleteIndexRequest`):
445448 The request object. The request for
446449 [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex].
447450 name (:class:`str`):
448451 Required. A name of the form
449452 ``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}``
453+
450454 This corresponds to the ``name`` field
451455 on the ``request`` instance; if ``request`` is provided, this
452456 should not be set.
@@ -516,12 +520,13 @@ async def get_field(
516520 r"""Gets the metadata and configuration for a Field.
517521
518522 Args:
519- request (:class:`~.firestore_admin .GetFieldRequest`):
523+ request (:class:`google.cloud.firestore_admin_v1.types .GetFieldRequest`):
520524 The request object. The request for
521525 [FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField].
522526 name (:class:`str`):
523527 Required. A name of the form
524528 ``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}``
529+
525530 This corresponds to the ``name`` field
526531 on the ``request`` instance; if ``request`` is provided, this
527532 should not be set.
@@ -533,7 +538,7 @@ async def get_field(
533538 sent along with the request as metadata.
534539
535540 Returns:
536- ~.field .Field:
541+ google.cloud.firestore_admin_v1.types .Field:
537542 Represents a single field in the
538543 database.
539544 Fields are grouped by their "Collection
@@ -616,10 +621,10 @@ async def update_field(
616621 ``projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*``.
617622
618623 Args:
619- request (:class:`~.firestore_admin .UpdateFieldRequest`):
624+ request (:class:`google.cloud.firestore_admin_v1.types .UpdateFieldRequest`):
620625 The request object. The request for
621626 [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
622- field (:class:`~.gfa_field .Field`):
627+ field (:class:`google.cloud.firestore_admin_v1.types .Field`):
623628 Required. The field to be updated.
624629 This corresponds to the ``field`` field
625630 on the ``request`` instance; if ``request`` is provided, this
@@ -632,16 +637,16 @@ async def update_field(
632637 sent along with the request as metadata.
633638
634639 Returns:
635- ~ .operation_async.AsyncOperation:
640+ google.api_core .operation_async.AsyncOperation:
636641 An object representing a long-running operation.
637642
638643 The result type for the operation will be
639- :class:``~.gfa_field. Field``: Represents a single field
640- in the database.
644+ :class:`google.cloud.firestore_admin_v1.types. Field`
645+ Represents a single field in the database.
641646
642- Fields are grouped by their "Collection Group", which
643- represent all collections in the database with the same
644- id.
647+ Fields are grouped by their "Collection Group", which
648+ represent all collections in the database with the
649+ same id.
645650
646651 """
647652 # Create or coerce a protobuf request object.
@@ -711,12 +716,13 @@ async def list_fields(
711716 with the filter set to ``indexConfig.usesAncestorConfig:false``.
712717
713718 Args:
714- request (:class:`~.firestore_admin .ListFieldsRequest`):
719+ request (:class:`google.cloud.firestore_admin_v1.types .ListFieldsRequest`):
715720 The request object. The request for
716721 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
717722 parent (:class:`str`):
718723 Required. A parent name of the form
719724 ``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}``
725+
720726 This corresponds to the ``parent`` field
721727 on the ``request`` instance; if ``request`` is provided, this
722728 should not be set.
@@ -728,7 +734,7 @@ async def list_fields(
728734 sent along with the request as metadata.
729735
730736 Returns:
731- ~ .pagers.ListFieldsAsyncPager:
737+ google.cloud.firestore_admin_v1.services.firestore_admin .pagers.ListFieldsAsyncPager:
732738 The response for
733739 [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
734740
@@ -811,12 +817,13 @@ async def export_documents(
811817 Google Cloud Storage.
812818
813819 Args:
814- request (:class:`~.firestore_admin .ExportDocumentsRequest`):
820+ request (:class:`google.cloud.firestore_admin_v1.types .ExportDocumentsRequest`):
815821 The request object. The request for
816822 [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
817823 name (:class:`str`):
818824 Required. Database to export. Should be of the form:
819825 ``projects/{project_id}/databases/{database_id}``.
826+
820827 This corresponds to the ``name`` field
821828 on the ``request`` instance; if ``request`` is provided, this
822829 should not be set.
@@ -828,11 +835,11 @@ async def export_documents(
828835 sent along with the request as metadata.
829836
830837 Returns:
831- ~ .operation_async.AsyncOperation:
838+ google.api_core .operation_async.AsyncOperation:
832839 An object representing a long-running operation.
833840
834841 The result type for the operation will be
835- :class:``~.gfa_operation. ExportDocumentsResponse``:
842+ :class:`google.cloud.firestore_admin_v1.types. ExportDocumentsResponse`
836843 Returned in the
837844 [google.longrunning.Operation][google.longrunning.Operation]
838845 response field.
@@ -902,12 +909,13 @@ async def import_documents(
902909 already been imported to Cloud Firestore.
903910
904911 Args:
905- request (:class:`~.firestore_admin .ImportDocumentsRequest`):
912+ request (:class:`google.cloud.firestore_admin_v1.types .ImportDocumentsRequest`):
906913 The request object. The request for
907914 [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
908915 name (:class:`str`):
909916 Required. Database to import into. Should be of the
910917 form: ``projects/{project_id}/databases/{database_id}``.
918+
911919 This corresponds to the ``name`` field
912920 on the ``request`` instance; if ``request`` is provided, this
913921 should not be set.
@@ -919,24 +927,22 @@ async def import_documents(
919927 sent along with the request as metadata.
920928
921929 Returns:
922- ~ .operation_async.AsyncOperation:
930+ google.api_core .operation_async.AsyncOperation:
923931 An object representing a long-running operation.
924932
925- The result type for the operation will be
926- :class:``~.empty.Empty``: A generic empty message that
927- you can re-use to avoid defining duplicated empty
928- messages in your APIs. A typical example is to use it as
929- the request or the response type of an API method. For
930- instance:
933+ The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated
934+ empty messages in your APIs. A typical example is to
935+ use it as the request or the response type of an API
936+ method. For instance:
931937
932- ::
938+ service Foo {
939+ rpc Bar(google.protobuf.Empty) returns
940+ (google.protobuf.Empty);
933941
934- service Foo {
935- rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
936- }
942+ }
937943
938- The JSON representation for `` Empty`` is empty JSON
939- object ``{}`` .
944+ The JSON representation for Empty is empty JSON
945+ object {} .
940946
941947 """
942948 # Create or coerce a protobuf request object.
0 commit comments