Skip to content

Commit

Permalink
chore: update templates (#308)
Browse files Browse the repository at this point in the history 
* 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 <8822365+busunkim96@users.noreply.github.com>
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 <crwilcox@google.com>
  • Loading branch information
@yoshi-automation @crwilcox
yoshi-automation and crwilcox committed Feb 18, 2021
1 parent baa27a0 commit a007675
Show file tree
Hide file tree
Showing 24 changed files with 560 additions and 757 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.rst
View file
Expand Up @@ -156,21 +156,21 @@ Running System Tests
`docs <https://cloud.google.com/storage/docs/authentication#generating-a-private-key>`__
for more details.

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

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


**************************
Updating Conformance Tests
**************************
Updating Conformance Tests
**************************

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

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

$ make -f Makefile_v1
$ make -f Makefile_v1

*************
Test Coverage
Expand Down
4 changes: 2 additions & 2 deletions MANIFEST.in
View file
Expand Up @@ -16,10 +16,10 @@

# Generated by synthtool. DO NOT EDIT!
include README.rst LICENSE
recursive-include google *.json *.proto
recursive-include google *.json *.proto py.typed
recursive-include tests *
global-exclude *.py[co]
global-exclude __pycache__

# Exclude scripts for samples readmegen
prune scripts/readme-gen
prune scripts/readme-gen
88 changes: 41 additions & 47 deletions google/cloud/firestore_admin_v1/services/firestore_admin/async_client.py
View file
Expand Up @@ -94,7 +94,6 @@ class FirestoreAdminAsyncClient:
FirestoreAdminClient.parse_common_location_path
)

from_service_account_info = FirestoreAdminClient.from_service_account_info
from_service_account_file = FirestoreAdminClient.from_service_account_file
from_service_account_json = from_service_account_file

Expand Down Expand Up @@ -176,20 +175,18 @@ async def create_index(
[IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].
Args:
request (:class:`google.cloud.firestore_admin_v1.types.CreateIndexRequest`):
request (:class:`~.firestore_admin.CreateIndexRequest`):
The request object. The request for
[FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
parent (:class:`str`):
Required. A parent name of the form
``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
index (:class:`google.cloud.firestore_admin_v1.types.Index`):
index (:class:`~.gfa_index.Index`):
Required. The composite index to
create.
This corresponds to the ``index`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
Expand All @@ -201,11 +198,13 @@ async def create_index(
sent along with the request as metadata.
Returns:
google.api_core.operation_async.AsyncOperation:
~.operation_async.AsyncOperation:
An object representing a long-running operation.
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
documents in a database.
The result type for the operation will be
:class:``~.gfa_index.Index``: Cloud Firestore indexes
enable simple and complex queries against documents in a
database.
"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -268,13 +267,12 @@ async def list_indexes(
r"""Lists composite indexes.
Args:
request (:class:`google.cloud.firestore_admin_v1.types.ListIndexesRequest`):
request (:class:`~.firestore_admin.ListIndexesRequest`):
The request object. The request for
[FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
parent (:class:`str`):
Required. A parent name of the form
``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
Expand All @@ -286,7 +284,7 @@ async def list_indexes(
sent along with the request as metadata.
Returns:
google.cloud.firestore_admin_v1.services.firestore_admin.pagers.ListIndexesAsyncPager:
~.pagers.ListIndexesAsyncPager:
The response for
[FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
Expand Down Expand Up @@ -360,13 +358,12 @@ async def get_index(
r"""Gets a composite index.
Args:
request (:class:`google.cloud.firestore_admin_v1.types.GetIndexRequest`):
request (:class:`~.firestore_admin.GetIndexRequest`):
The request object. The request for
[FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex].
name (:class:`str`):
Required. A name of the form
``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
Expand All @@ -378,7 +375,7 @@ async def get_index(
sent along with the request as metadata.
Returns:
google.cloud.firestore_admin_v1.types.Index:
~.index.Index:
Cloud Firestore indexes enable simple
and complex queries against documents in
a database.
Expand Down Expand Up @@ -444,13 +441,12 @@ async def delete_index(
r"""Deletes a composite index.
Args:
request (:class:`google.cloud.firestore_admin_v1.types.DeleteIndexRequest`):
request (:class:`~.firestore_admin.DeleteIndexRequest`):
The request object. The request for
[FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex].
name (:class:`str`):
Required. A name of the form
``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
Expand Down Expand Up @@ -520,13 +516,12 @@ async def get_field(
r"""Gets the metadata and configuration for a Field.
Args:
request (:class:`google.cloud.firestore_admin_v1.types.GetFieldRequest`):
request (:class:`~.firestore_admin.GetFieldRequest`):
The request object. The request for
[FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField].
name (:class:`str`):
Required. A name of the form
``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}``
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
Expand All @@ -538,7 +533,7 @@ async def get_field(
sent along with the request as metadata.
Returns:
google.cloud.firestore_admin_v1.types.Field:
~.field.Field:
Represents a single field in the
database.
Fields are grouped by their "Collection
Expand Down Expand Up @@ -621,10 +616,10 @@ async def update_field(
``projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*``.
Args:
request (:class:`google.cloud.firestore_admin_v1.types.UpdateFieldRequest`):
request (:class:`~.firestore_admin.UpdateFieldRequest`):
The request object. The request for
[FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
field (:class:`google.cloud.firestore_admin_v1.types.Field`):
field (:class:`~.gfa_field.Field`):
Required. The field to be updated.
This corresponds to the ``field`` field
on the ``request`` instance; if ``request`` is provided, this
Expand All @@ -637,16 +632,16 @@ async def update_field(
sent along with the request as metadata.
Returns:
google.api_core.operation_async.AsyncOperation:
~.operation_async.AsyncOperation:
An object representing a long-running operation.
The result type for the operation will be
:class:`google.cloud.firestore_admin_v1.types.Field`
Represents a single field in the database.
:class:``~.gfa_field.Field``: Represents a single field
in the database.
Fields are grouped by their "Collection Group", which
represent all collections in the database with the
same id.
Fields are grouped by their "Collection Group", which
represent all collections in the database with the same
id.
"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -716,13 +711,12 @@ async def list_fields(
with the filter set to ``indexConfig.usesAncestorConfig:false``.
Args:
request (:class:`google.cloud.firestore_admin_v1.types.ListFieldsRequest`):
request (:class:`~.firestore_admin.ListFieldsRequest`):
The request object. The request for
[FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
parent (:class:`str`):
Required. A parent name of the form
``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
Expand All @@ -734,7 +728,7 @@ async def list_fields(
sent along with the request as metadata.
Returns:
google.cloud.firestore_admin_v1.services.firestore_admin.pagers.ListFieldsAsyncPager:
~.pagers.ListFieldsAsyncPager:
The response for
[FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
Expand Down Expand Up @@ -817,13 +811,12 @@ async def export_documents(
Google Cloud Storage.
Args:
request (:class:`google.cloud.firestore_admin_v1.types.ExportDocumentsRequest`):
request (:class:`~.firestore_admin.ExportDocumentsRequest`):
The request object. The request for
[FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
name (:class:`str`):
Required. Database to export. Should be of the form:
``projects/{project_id}/databases/{database_id}``.
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
Expand All @@ -835,11 +828,11 @@ async def export_documents(
sent along with the request as metadata.
Returns:
google.api_core.operation_async.AsyncOperation:
~.operation_async.AsyncOperation:
An object representing a long-running operation.
The result type for the operation will be
:class:`google.cloud.firestore_admin_v1.types.ExportDocumentsResponse`
:class:``~.gfa_operation.ExportDocumentsResponse``:
Returned in the
[google.longrunning.Operation][google.longrunning.Operation]
response field.
Expand Down Expand Up @@ -909,13 +902,12 @@ async def import_documents(
already been imported to Cloud Firestore.
Args:
request (:class:`google.cloud.firestore_admin_v1.types.ImportDocumentsRequest`):
request (:class:`~.firestore_admin.ImportDocumentsRequest`):
The request object. The request for
[FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
name (:class:`str`):
Required. Database to import into. Should be of the
form: ``projects/{project_id}/databases/{database_id}``.
This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
Expand All @@ -927,22 +919,24 @@ async def import_documents(
sent along with the request as metadata.
Returns:
google.api_core.operation_async.AsyncOperation:
~.operation_async.AsyncOperation:
An object representing a long-running operation.
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
empty messages in your APIs. A typical example is to
use it as the request or the response type of an API
method. For instance:
The result type for the operation will be
:class:``~.empty.Empty``: A generic empty message that
you can re-use to avoid defining duplicated empty
messages in your APIs. A typical example is to use it as
the request or the response type of an API method. For
instance:
service Foo {
rpc Bar(google.protobuf.Empty) returns
(google.protobuf.Empty);
::
}
service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}
The JSON representation for Empty is empty JSON
object {}.
The JSON representation for ``Empty`` is empty JSON
object ``{}``.
"""
# Create or coerce a protobuf request object.
Expand Down

0 comments on commit a007675

Please sign in to comment.