Skip to content

Commit 2446454

Browse files
chore: update templates (#308)
* changes without context autosynth cannot find the source of changes triggered by earlier changes in this repository, or by version upgrades to tools such as linters. * chore(python): include py.typed files in release A py.typed file must be included in the released package for it to be considered typed by type checkers. https://www.python.org/dev/peps/pep-0561/#packaging-type-information. See googleapis/python-secret-manager#79 Source-Author: Bu Sun Kim <[email protected]> Source-Date: Fri Feb 5 17:32:06 2021 -0700 Source-Repo: googleapis/synthtool Source-Sha: 33366574ffb9e11737b3547eb6f020ecae0536e8 Source-Link: googleapis/synthtool@3336657 Co-authored-by: Christopher Wilcox <[email protected]>
1 parent 67101e4 commit 2446454

File tree

24 files changed

+560
-757
lines changed

24 files changed

+560
-757
lines changed

packages/google-cloud-firestore/CONTRIBUTING.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -156,21 +156,21 @@ Running System Tests
156156
`docs <https://cloud.google.com/storage/docs/authentication#generating-a-private-key>`__
157157
for more details.
158158

159-
- Once you have downloaded your json keys, set the environment variable
159+
- Once you have downloaded your json keys, set the environment variable
160160
``GOOGLE_APPLICATION_CREDENTIALS`` to the absolute path of the json file::
161161

162162
$ export GOOGLE_APPLICATION_CREDENTIALS="/Users/<your_username>/path/to/app_credentials.json"
163163

164164

165165
**************************
166-
Updating Conformance Tests
167-
**************************
166+
Updating Conformance Tests
167+
**************************
168168

169-
The firestore client libraries use a shared set of conformance tests, the source of which can be found at https://github.com/googleapis/conformance-tests.
169+
The firestore client libraries use a shared set of conformance tests, the source of which can be found at https://github.com/googleapis/conformance-tests.
170170

171-
To update the copy of these conformance tests used by this repository, run the provided Makefile:
171+
To update the copy of these conformance tests used by this repository, run the provided Makefile:
172172

173-
$ make -f Makefile_v1
173+
$ make -f Makefile_v1
174174

175175
*************
176176
Test Coverage

packages/google-cloud-firestore/MANIFEST.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@
1616

1717
# Generated by synthtool. DO NOT EDIT!
1818
include README.rst LICENSE
19-
recursive-include google *.json *.proto
19+
recursive-include google *.json *.proto py.typed
2020
recursive-include tests *
2121
global-exclude *.py[co]
2222
global-exclude __pycache__
2323

2424
# Exclude scripts for samples readmegen
25-
prune scripts/readme-gen
25+
prune scripts/readme-gen

packages/google-cloud-firestore/google/cloud/firestore_admin_v1/services/firestore_admin/async_client.py

Lines changed: 41 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,6 @@ class FirestoreAdminAsyncClient:
9494
FirestoreAdminClient.parse_common_location_path
9595
)
9696

97-
from_service_account_info = FirestoreAdminClient.from_service_account_info
9897
from_service_account_file = FirestoreAdminClient.from_service_account_file
9998
from_service_account_json = from_service_account_file
10099

@@ -176,20 +175,18 @@ async def create_index(
176175
[IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].
177176
178177
Args:
179-
request (:class:`google.cloud.firestore_admin_v1.types.CreateIndexRequest`):
178+
request (:class:`~.firestore_admin.CreateIndexRequest`):
180179
The request object. The request for
181180
[FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
182181
parent (:class:`str`):
183182
Required. A parent name of the form
184183
``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}``
185-
186184
This corresponds to the ``parent`` field
187185
on the ``request`` instance; if ``request`` is provided, this
188186
should not be set.
189-
index (:class:`google.cloud.firestore_admin_v1.types.Index`):
187+
index (:class:`~.gfa_index.Index`):
190188
Required. The composite index to
191189
create.
192-
193190
This corresponds to the ``index`` field
194191
on the ``request`` instance; if ``request`` is provided, this
195192
should not be set.
@@ -201,11 +198,13 @@ async def create_index(
201198
sent along with the request as metadata.
202199
203200
Returns:
204-
google.api_core.operation_async.AsyncOperation:
201+
~.operation_async.AsyncOperation:
205202
An object representing a long-running operation.
206203
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.
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.
209208
210209
"""
211210
# Create or coerce a protobuf request object.
@@ -268,13 +267,12 @@ async def list_indexes(
268267
r"""Lists composite indexes.
269268
270269
Args:
271-
request (:class:`google.cloud.firestore_admin_v1.types.ListIndexesRequest`):
270+
request (:class:`~.firestore_admin.ListIndexesRequest`):
272271
The request object. The request for
273272
[FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
274273
parent (:class:`str`):
275274
Required. A parent name of the form
276275
``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}``
277-
278276
This corresponds to the ``parent`` field
279277
on the ``request`` instance; if ``request`` is provided, this
280278
should not be set.
@@ -286,7 +284,7 @@ async def list_indexes(
286284
sent along with the request as metadata.
287285
288286
Returns:
289-
google.cloud.firestore_admin_v1.services.firestore_admin.pagers.ListIndexesAsyncPager:
287+
~.pagers.ListIndexesAsyncPager:
290288
The response for
291289
[FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
292290
@@ -360,13 +358,12 @@ async def get_index(
360358
r"""Gets a composite index.
361359
362360
Args:
363-
request (:class:`google.cloud.firestore_admin_v1.types.GetIndexRequest`):
361+
request (:class:`~.firestore_admin.GetIndexRequest`):
364362
The request object. The request for
365363
[FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex].
366364
name (:class:`str`):
367365
Required. A name of the form
368366
``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}``
369-
370367
This corresponds to the ``name`` field
371368
on the ``request`` instance; if ``request`` is provided, this
372369
should not be set.
@@ -378,7 +375,7 @@ async def get_index(
378375
sent along with the request as metadata.
379376
380377
Returns:
381-
google.cloud.firestore_admin_v1.types.Index:
378+
~.index.Index:
382379
Cloud Firestore indexes enable simple
383380
and complex queries against documents in
384381
a database.
@@ -444,13 +441,12 @@ async def delete_index(
444441
r"""Deletes a composite index.
445442
446443
Args:
447-
request (:class:`google.cloud.firestore_admin_v1.types.DeleteIndexRequest`):
444+
request (:class:`~.firestore_admin.DeleteIndexRequest`):
448445
The request object. The request for
449446
[FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex].
450447
name (:class:`str`):
451448
Required. A name of the form
452449
``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}``
453-
454450
This corresponds to the ``name`` field
455451
on the ``request`` instance; if ``request`` is provided, this
456452
should not be set.
@@ -520,13 +516,12 @@ async def get_field(
520516
r"""Gets the metadata and configuration for a Field.
521517
522518
Args:
523-
request (:class:`google.cloud.firestore_admin_v1.types.GetFieldRequest`):
519+
request (:class:`~.firestore_admin.GetFieldRequest`):
524520
The request object. The request for
525521
[FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField].
526522
name (:class:`str`):
527523
Required. A name of the form
528524
``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}``
529-
530525
This corresponds to the ``name`` field
531526
on the ``request`` instance; if ``request`` is provided, this
532527
should not be set.
@@ -538,7 +533,7 @@ async def get_field(
538533
sent along with the request as metadata.
539534
540535
Returns:
541-
google.cloud.firestore_admin_v1.types.Field:
536+
~.field.Field:
542537
Represents a single field in the
543538
database.
544539
Fields are grouped by their "Collection
@@ -621,10 +616,10 @@ async def update_field(
621616
``projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*``.
622617
623618
Args:
624-
request (:class:`google.cloud.firestore_admin_v1.types.UpdateFieldRequest`):
619+
request (:class:`~.firestore_admin.UpdateFieldRequest`):
625620
The request object. The request for
626621
[FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
627-
field (:class:`google.cloud.firestore_admin_v1.types.Field`):
622+
field (:class:`~.gfa_field.Field`):
628623
Required. The field to be updated.
629624
This corresponds to the ``field`` field
630625
on the ``request`` instance; if ``request`` is provided, this
@@ -637,16 +632,16 @@ async def update_field(
637632
sent along with the request as metadata.
638633
639634
Returns:
640-
google.api_core.operation_async.AsyncOperation:
635+
~.operation_async.AsyncOperation:
641636
An object representing a long-running operation.
642637
643638
The result type for the operation will be
644-
:class:`google.cloud.firestore_admin_v1.types.Field`
645-
Represents a single field in the database.
639+
:class:``~.gfa_field.Field``: Represents a single field
640+
in the database.
646641
647-
Fields are grouped by their "Collection Group", which
648-
represent all collections in the database with the
649-
same id.
642+
Fields are grouped by their "Collection Group", which
643+
represent all collections in the database with the same
644+
id.
650645
651646
"""
652647
# Create or coerce a protobuf request object.
@@ -716,13 +711,12 @@ async def list_fields(
716711
with the filter set to ``indexConfig.usesAncestorConfig:false``.
717712
718713
Args:
719-
request (:class:`google.cloud.firestore_admin_v1.types.ListFieldsRequest`):
714+
request (:class:`~.firestore_admin.ListFieldsRequest`):
720715
The request object. The request for
721716
[FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
722717
parent (:class:`str`):
723718
Required. A parent name of the form
724719
``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}``
725-
726720
This corresponds to the ``parent`` field
727721
on the ``request`` instance; if ``request`` is provided, this
728722
should not be set.
@@ -734,7 +728,7 @@ async def list_fields(
734728
sent along with the request as metadata.
735729
736730
Returns:
737-
google.cloud.firestore_admin_v1.services.firestore_admin.pagers.ListFieldsAsyncPager:
731+
~.pagers.ListFieldsAsyncPager:
738732
The response for
739733
[FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
740734
@@ -817,13 +811,12 @@ async def export_documents(
817811
Google Cloud Storage.
818812
819813
Args:
820-
request (:class:`google.cloud.firestore_admin_v1.types.ExportDocumentsRequest`):
814+
request (:class:`~.firestore_admin.ExportDocumentsRequest`):
821815
The request object. The request for
822816
[FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
823817
name (:class:`str`):
824818
Required. Database to export. Should be of the form:
825819
``projects/{project_id}/databases/{database_id}``.
826-
827820
This corresponds to the ``name`` field
828821
on the ``request`` instance; if ``request`` is provided, this
829822
should not be set.
@@ -835,11 +828,11 @@ async def export_documents(
835828
sent along with the request as metadata.
836829
837830
Returns:
838-
google.api_core.operation_async.AsyncOperation:
831+
~.operation_async.AsyncOperation:
839832
An object representing a long-running operation.
840833
841834
The result type for the operation will be
842-
:class:`google.cloud.firestore_admin_v1.types.ExportDocumentsResponse`
835+
:class:``~.gfa_operation.ExportDocumentsResponse``:
843836
Returned in the
844837
[google.longrunning.Operation][google.longrunning.Operation]
845838
response field.
@@ -909,13 +902,12 @@ async def import_documents(
909902
already been imported to Cloud Firestore.
910903
911904
Args:
912-
request (:class:`google.cloud.firestore_admin_v1.types.ImportDocumentsRequest`):
905+
request (:class:`~.firestore_admin.ImportDocumentsRequest`):
913906
The request object. The request for
914907
[FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
915908
name (:class:`str`):
916909
Required. Database to import into. Should be of the
917910
form: ``projects/{project_id}/databases/{database_id}``.
918-
919911
This corresponds to the ``name`` field
920912
on the ``request`` instance; if ``request`` is provided, this
921913
should not be set.
@@ -927,22 +919,24 @@ async def import_documents(
927919
sent along with the request as metadata.
928920
929921
Returns:
930-
google.api_core.operation_async.AsyncOperation:
922+
~.operation_async.AsyncOperation:
931923
An object representing a long-running operation.
932924
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:
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:
937931
938-
service Foo {
939-
rpc Bar(google.protobuf.Empty) returns
940-
(google.protobuf.Empty);
932+
::
941933
942-
}
934+
service Foo {
935+
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
936+
}
943937
944-
The JSON representation for Empty is empty JSON
945-
object {}.
938+
The JSON representation for ``Empty`` is empty JSON
939+
object ``{}``.
946940
947941
"""
948942
# Create or coerce a protobuf request object.

0 commit comments

Comments
 (0)