diff --git a/google/cloud/spanner_admin_database_v1/services/database_admin/async_client.py b/google/cloud/spanner_admin_database_v1/services/database_admin/async_client.py index 750c3dd5f5..c5d38710bf 100644 --- a/google/cloud/spanner_admin_database_v1/services/database_admin/async_client.py +++ b/google/cloud/spanner_admin_database_v1/services/database_admin/async_client.py @@ -16,7 +16,7 @@ from collections import OrderedDict import functools import re -from typing import Dict, Optional, Sequence, Tuple, Type, Union +from typing import Dict, Mapping, Optional, Sequence, Tuple, Type, Union import pkg_resources from google.api_core.client_options import ClientOptions @@ -371,7 +371,6 @@ async def create_database( is [Database][google.spanner.admin.database.v1.Database], if successful. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -611,7 +610,6 @@ async def update_database_ddl( [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -770,7 +768,6 @@ async def drop_database( ``expire_time``. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -865,7 +862,6 @@ async def get_database_ddl( schema updates, those may be queried using the [Operations][google.longrunning.Operations] API. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -980,17 +976,17 @@ async def set_iam_policy( permission on [resource][google.iam.v1.SetIamPolicyRequest.resource]. - .. code-block:: python from google.cloud import spanner_admin_database_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_set_iam_policy(): # Create a client client = spanner_admin_database_v1.DatabaseAdminClient() # Initialize request argument(s) - request = spanner_admin_database_v1.SetIamPolicyRequest( + request = iam_policy_pb2.SetIamPolicyRequest( resource="resource_value", ) @@ -1021,21 +1017,26 @@ def sample_set_iam_policy(): Returns: google.iam.v1.policy_pb2.Policy: - Defines an Identity and Access Management (IAM) policy. It is used to - specify access control policies for Cloud Platform - resources. + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds - one or more members to a single role. Members can be - user accounts, service accounts, Google groups, and - domains (such as G Suite). A role is a named list of - permissions (defined by IAM or configured by users). - A binding can optionally specify a condition, which - is a logic expression that further constrains the - role binding based on attributes about the request - and/or target resource. - - **JSON Example** + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** { "bindings": [ @@ -1050,17 +1051,17 @@ def sample_set_iam_policy(): }, { "role": "roles/resourcemanager.organizationViewer", - "members": ["user:eve@example.com"], + "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } - ] + ], "etag": "BwWWja0YfJA=", "version": 3 } - **YAML Example** + **YAML example:** bindings: - members: - user:\ mike@example.com - group:\ admins@example.com - domain:google.com - @@ -1071,11 +1072,12 @@ def sample_set_iam_policy(): condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') + timestamp('2020-10-01T00:00:00.000Z') etag: + BwWWja0YfJA= version: 3 For a description of IAM and its features, see the - [IAM developer's - guide](\ https://cloud.google.com/iam/docs). + [IAM + documentation](\ https://cloud.google.com/iam/docs/). """ # Create or coerce a protobuf request object. @@ -1142,17 +1144,17 @@ async def get_iam_policy( permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. - .. code-block:: python from google.cloud import spanner_admin_database_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_get_iam_policy(): # Create a client client = spanner_admin_database_v1.DatabaseAdminClient() # Initialize request argument(s) - request = spanner_admin_database_v1.GetIamPolicyRequest( + request = iam_policy_pb2.GetIamPolicyRequest( resource="resource_value", ) @@ -1183,21 +1185,26 @@ def sample_get_iam_policy(): Returns: google.iam.v1.policy_pb2.Policy: - Defines an Identity and Access Management (IAM) policy. It is used to - specify access control policies for Cloud Platform - resources. + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds - one or more members to a single role. Members can be - user accounts, service accounts, Google groups, and - domains (such as G Suite). A role is a named list of - permissions (defined by IAM or configured by users). - A binding can optionally specify a condition, which - is a logic expression that further constrains the - role binding based on attributes about the request - and/or target resource. - - **JSON Example** + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** { "bindings": [ @@ -1212,17 +1219,17 @@ def sample_get_iam_policy(): }, { "role": "roles/resourcemanager.organizationViewer", - "members": ["user:eve@example.com"], + "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } - ] + ], "etag": "BwWWja0YfJA=", "version": 3 } - **YAML Example** + **YAML example:** bindings: - members: - user:\ mike@example.com - group:\ admins@example.com - domain:google.com - @@ -1233,11 +1240,12 @@ def sample_get_iam_policy(): condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') + timestamp('2020-10-01T00:00:00.000Z') etag: + BwWWja0YfJA= version: 3 For a description of IAM and its features, see the - [IAM developer's - guide](\ https://cloud.google.com/iam/docs). + [IAM + documentation](\ https://cloud.google.com/iam/docs/). """ # Create or coerce a protobuf request object. @@ -1315,17 +1323,17 @@ async def test_iam_permissions( in a NOT_FOUND error if the user has ``spanner.backups.list`` permission on the containing instance. - .. code-block:: python from google.cloud import spanner_admin_database_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_test_iam_permissions(): # Create a client client = spanner_admin_database_v1.DatabaseAdminClient() # Initialize request argument(s) - request = spanner_admin_database_v1.TestIamPermissionsRequest( + request = iam_policy_pb2.TestIamPermissionsRequest( resource="resource_value", permissions=['permissions_value_1', 'permissions_value_2'], ) @@ -1438,7 +1446,6 @@ async def create_backup( backup creation per database. Backup creation of different databases can run concurrently. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -1588,7 +1595,6 @@ async def copy_backup( copying and delete the backup. Concurrent CopyBackup requests can run on the same source backup. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -1741,7 +1747,6 @@ async def get_backup( r"""Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -1847,7 +1852,6 @@ async def update_backup( r"""Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -1971,7 +1975,6 @@ async def delete_backup( r"""Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -2068,7 +2071,6 @@ async def list_backups( ordered by ``create_time`` in descending order, starting from the most recent ``create_time``. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -2207,7 +2209,6 @@ async def restore_database( without waiting for the optimize operation associated with the first restore to complete. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -2356,7 +2357,6 @@ async def list_database_operations( completed/failed/canceled within the last 7 days, and pending operations. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -2487,7 +2487,6 @@ async def list_backup_operations( ``operation.metadata.value.progress.start_time`` in descending order starting from the most recently started operation. - .. code-block:: python from google.cloud import spanner_admin_database_v1 diff --git a/google/cloud/spanner_admin_database_v1/services/database_admin/client.py b/google/cloud/spanner_admin_database_v1/services/database_admin/client.py index 3e300807c9..19bbf83097 100644 --- a/google/cloud/spanner_admin_database_v1/services/database_admin/client.py +++ b/google/cloud/spanner_admin_database_v1/services/database_admin/client.py @@ -16,7 +16,7 @@ from collections import OrderedDict import os import re -from typing import Dict, Optional, Sequence, Tuple, Type, Union +from typing import Dict, Mapping, Optional, Sequence, Tuple, Type, Union import pkg_resources from google.api_core import client_options as client_options_lib @@ -662,7 +662,6 @@ def create_database( is [Database][google.spanner.admin.database.v1.Database], if successful. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -892,7 +891,6 @@ def update_database_ddl( [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -1041,7 +1039,6 @@ def drop_database( ``expire_time``. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -1126,7 +1123,6 @@ def get_database_ddl( schema updates, those may be queried using the [Operations][google.longrunning.Operations] API. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -1231,17 +1227,17 @@ def set_iam_policy( permission on [resource][google.iam.v1.SetIamPolicyRequest.resource]. - .. code-block:: python from google.cloud import spanner_admin_database_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_set_iam_policy(): # Create a client client = spanner_admin_database_v1.DatabaseAdminClient() # Initialize request argument(s) - request = spanner_admin_database_v1.SetIamPolicyRequest( + request = iam_policy_pb2.SetIamPolicyRequest( resource="resource_value", ) @@ -1272,21 +1268,26 @@ def sample_set_iam_policy(): Returns: google.iam.v1.policy_pb2.Policy: - Defines an Identity and Access Management (IAM) policy. It is used to - specify access control policies for Cloud Platform - resources. + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds - one or more members to a single role. Members can be - user accounts, service accounts, Google groups, and - domains (such as G Suite). A role is a named list of - permissions (defined by IAM or configured by users). - A binding can optionally specify a condition, which - is a logic expression that further constrains the - role binding based on attributes about the request - and/or target resource. - - **JSON Example** + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** { "bindings": [ @@ -1301,17 +1302,17 @@ def sample_set_iam_policy(): }, { "role": "roles/resourcemanager.organizationViewer", - "members": ["user:eve@example.com"], + "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } - ] + ], "etag": "BwWWja0YfJA=", "version": 3 } - **YAML Example** + **YAML example:** bindings: - members: - user:\ mike@example.com - group:\ admins@example.com - domain:google.com - @@ -1322,11 +1323,12 @@ def sample_set_iam_policy(): condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') + timestamp('2020-10-01T00:00:00.000Z') etag: + BwWWja0YfJA= version: 3 For a description of IAM and its features, see the - [IAM developer's - guide](\ https://cloud.google.com/iam/docs). + [IAM + documentation](\ https://cloud.google.com/iam/docs/). """ # Create or coerce a protobuf request object. @@ -1390,17 +1392,17 @@ def get_iam_policy( permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. - .. code-block:: python from google.cloud import spanner_admin_database_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_get_iam_policy(): # Create a client client = spanner_admin_database_v1.DatabaseAdminClient() # Initialize request argument(s) - request = spanner_admin_database_v1.GetIamPolicyRequest( + request = iam_policy_pb2.GetIamPolicyRequest( resource="resource_value", ) @@ -1431,21 +1433,26 @@ def sample_get_iam_policy(): Returns: google.iam.v1.policy_pb2.Policy: - Defines an Identity and Access Management (IAM) policy. It is used to - specify access control policies for Cloud Platform - resources. + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds - one or more members to a single role. Members can be - user accounts, service accounts, Google groups, and - domains (such as G Suite). A role is a named list of - permissions (defined by IAM or configured by users). - A binding can optionally specify a condition, which - is a logic expression that further constrains the - role binding based on attributes about the request - and/or target resource. - - **JSON Example** + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** { "bindings": [ @@ -1460,17 +1467,17 @@ def sample_get_iam_policy(): }, { "role": "roles/resourcemanager.organizationViewer", - "members": ["user:eve@example.com"], + "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } - ] + ], "etag": "BwWWja0YfJA=", "version": 3 } - **YAML Example** + **YAML example:** bindings: - members: - user:\ mike@example.com - group:\ admins@example.com - domain:google.com - @@ -1481,11 +1488,12 @@ def sample_get_iam_policy(): condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') + timestamp('2020-10-01T00:00:00.000Z') etag: + BwWWja0YfJA= version: 3 For a description of IAM and its features, see the - [IAM developer's - guide](\ https://cloud.google.com/iam/docs). + [IAM + documentation](\ https://cloud.google.com/iam/docs/). """ # Create or coerce a protobuf request object. @@ -1550,17 +1558,17 @@ def test_iam_permissions( in a NOT_FOUND error if the user has ``spanner.backups.list`` permission on the containing instance. - .. code-block:: python from google.cloud import spanner_admin_database_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_test_iam_permissions(): # Create a client client = spanner_admin_database_v1.DatabaseAdminClient() # Initialize request argument(s) - request = spanner_admin_database_v1.TestIamPermissionsRequest( + request = iam_policy_pb2.TestIamPermissionsRequest( resource="resource_value", permissions=['permissions_value_1', 'permissions_value_2'], ) @@ -1671,7 +1679,6 @@ def create_backup( backup creation per database. Backup creation of different databases can run concurrently. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -1821,7 +1828,6 @@ def copy_backup( copying and delete the backup. Concurrent CopyBackup requests can run on the same source backup. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -1974,7 +1980,6 @@ def get_backup( r"""Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -2070,7 +2075,6 @@ def update_backup( r"""Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -2184,7 +2188,6 @@ def delete_backup( r"""Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -2271,7 +2274,6 @@ def list_backups( ordered by ``create_time`` in descending order, starting from the most recent ``create_time``. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -2400,7 +2402,6 @@ def restore_database( without waiting for the optimize operation associated with the first restore to complete. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -2549,7 +2550,6 @@ def list_database_operations( completed/failed/canceled within the last 7 days, and pending operations. - .. code-block:: python from google.cloud import spanner_admin_database_v1 @@ -2672,7 +2672,6 @@ def list_backup_operations( ``operation.metadata.value.progress.start_time`` in descending order starting from the most recently started operation. - .. code-block:: python from google.cloud import spanner_admin_database_v1 diff --git a/google/cloud/spanner_admin_database_v1/services/database_admin/transports/base.py b/google/cloud/spanner_admin_database_v1/services/database_admin/transports/base.py index 21f27aeaf6..1a93ed842a 100644 --- a/google/cloud/spanner_admin_database_v1/services/database_admin/transports/base.py +++ b/google/cloud/spanner_admin_database_v1/services/database_admin/transports/base.py @@ -90,6 +90,7 @@ def __init__( always_use_jwt_access (Optional[bool]): Whether self signed JWT should be used for service account credentials. """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. if ":" not in host: host += ":443" @@ -533,5 +534,9 @@ def list_backup_operations( ]: raise NotImplementedError() + @property + def kind(self) -> str: + raise NotImplementedError() + __all__ = ("DatabaseAdminTransport",) diff --git a/google/cloud/spanner_admin_database_v1/services/database_admin/transports/grpc.py b/google/cloud/spanner_admin_database_v1/services/database_admin/transports/grpc.py index 70b1c8158a..18e9341dca 100644 --- a/google/cloud/spanner_admin_database_v1/services/database_admin/transports/grpc.py +++ b/google/cloud/spanner_admin_database_v1/services/database_admin/transports/grpc.py @@ -861,5 +861,9 @@ def list_backup_operations( def close(self): self.grpc_channel.close() + @property + def kind(self) -> str: + return "grpc" + __all__ = ("DatabaseAdminGrpcTransport",) diff --git a/google/cloud/spanner_admin_instance_v1/services/instance_admin/async_client.py b/google/cloud/spanner_admin_instance_v1/services/instance_admin/async_client.py index 1d79ac996e..4bbd9558c2 100644 --- a/google/cloud/spanner_admin_instance_v1/services/instance_admin/async_client.py +++ b/google/cloud/spanner_admin_instance_v1/services/instance_admin/async_client.py @@ -16,7 +16,7 @@ from collections import OrderedDict import functools import re -from typing import Dict, Optional, Sequence, Tuple, Type, Union +from typing import Dict, Mapping, Optional, Sequence, Tuple, Type, Union import pkg_resources from google.api_core.client_options import ClientOptions @@ -244,7 +244,6 @@ async def list_instance_configs( r"""Lists the supported instance configurations for a given project. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 @@ -365,7 +364,6 @@ async def get_instance_config( r"""Gets information about a particular instance configuration. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 @@ -738,7 +736,6 @@ async def create_instance( is [Instance][google.spanner.admin.instance.v1.Instance], if successful. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 @@ -922,7 +919,6 @@ async def update_instance( on resource [name][google.spanner.admin.instance.v1.Instance.name]. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 @@ -1068,7 +1064,6 @@ async def delete_instance( irrevocably disappear from the API. All data in the databases is permanently deleted. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 @@ -1167,17 +1162,17 @@ async def set_iam_policy( Authorization requires ``spanner.instances.setIamPolicy`` on [resource][google.iam.v1.SetIamPolicyRequest.resource]. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_set_iam_policy(): # Create a client client = spanner_admin_instance_v1.InstanceAdminClient() # Initialize request argument(s) - request = spanner_admin_instance_v1.SetIamPolicyRequest( + request = iam_policy_pb2.SetIamPolicyRequest( resource="resource_value", ) @@ -1208,21 +1203,26 @@ def sample_set_iam_policy(): Returns: google.iam.v1.policy_pb2.Policy: - Defines an Identity and Access Management (IAM) policy. It is used to - specify access control policies for Cloud Platform - resources. + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds - one or more members to a single role. Members can be - user accounts, service accounts, Google groups, and - domains (such as G Suite). A role is a named list of - permissions (defined by IAM or configured by users). - A binding can optionally specify a condition, which - is a logic expression that further constrains the - role binding based on attributes about the request - and/or target resource. - - **JSON Example** + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** { "bindings": [ @@ -1237,17 +1237,17 @@ def sample_set_iam_policy(): }, { "role": "roles/resourcemanager.organizationViewer", - "members": ["user:eve@example.com"], + "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } - ] + ], "etag": "BwWWja0YfJA=", "version": 3 } - **YAML Example** + **YAML example:** bindings: - members: - user:\ mike@example.com - group:\ admins@example.com - domain:google.com - @@ -1258,11 +1258,12 @@ def sample_set_iam_policy(): condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') + timestamp('2020-10-01T00:00:00.000Z') etag: + BwWWja0YfJA= version: 3 For a description of IAM and its features, see the - [IAM developer's - guide](\ https://cloud.google.com/iam/docs). + [IAM + documentation](\ https://cloud.google.com/iam/docs/). """ # Create or coerce a protobuf request object. @@ -1325,17 +1326,17 @@ async def get_iam_policy( Authorization requires ``spanner.instances.getIamPolicy`` on [resource][google.iam.v1.GetIamPolicyRequest.resource]. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_get_iam_policy(): # Create a client client = spanner_admin_instance_v1.InstanceAdminClient() # Initialize request argument(s) - request = spanner_admin_instance_v1.GetIamPolicyRequest( + request = iam_policy_pb2.GetIamPolicyRequest( resource="resource_value", ) @@ -1366,21 +1367,26 @@ def sample_get_iam_policy(): Returns: google.iam.v1.policy_pb2.Policy: - Defines an Identity and Access Management (IAM) policy. It is used to - specify access control policies for Cloud Platform - resources. + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds - one or more members to a single role. Members can be - user accounts, service accounts, Google groups, and - domains (such as G Suite). A role is a named list of - permissions (defined by IAM or configured by users). - A binding can optionally specify a condition, which - is a logic expression that further constrains the - role binding based on attributes about the request - and/or target resource. - - **JSON Example** + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** { "bindings": [ @@ -1395,17 +1401,17 @@ def sample_get_iam_policy(): }, { "role": "roles/resourcemanager.organizationViewer", - "members": ["user:eve@example.com"], + "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } - ] + ], "etag": "BwWWja0YfJA=", "version": 3 } - **YAML Example** + **YAML example:** bindings: - members: - user:\ mike@example.com - group:\ admins@example.com - domain:google.com - @@ -1416,11 +1422,12 @@ def sample_get_iam_policy(): condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') + timestamp('2020-10-01T00:00:00.000Z') etag: + BwWWja0YfJA= version: 3 For a description of IAM and its features, see the - [IAM developer's - guide](\ https://cloud.google.com/iam/docs). + [IAM + documentation](\ https://cloud.google.com/iam/docs/). """ # Create or coerce a protobuf request object. @@ -1495,17 +1502,17 @@ async def test_iam_permissions( ``spanner.instances.list`` permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_test_iam_permissions(): # Create a client client = spanner_admin_instance_v1.InstanceAdminClient() # Initialize request argument(s) - request = spanner_admin_instance_v1.TestIamPermissionsRequest( + request = iam_policy_pb2.TestIamPermissionsRequest( resource="resource_value", permissions=['permissions_value_1', 'permissions_value_2'], ) diff --git a/google/cloud/spanner_admin_instance_v1/services/instance_admin/client.py b/google/cloud/spanner_admin_instance_v1/services/instance_admin/client.py index 1ebf127487..9df92c95e6 100644 --- a/google/cloud/spanner_admin_instance_v1/services/instance_admin/client.py +++ b/google/cloud/spanner_admin_instance_v1/services/instance_admin/client.py @@ -16,7 +16,7 @@ from collections import OrderedDict import os import re -from typing import Dict, Optional, Sequence, Tuple, Type, Union +from typing import Dict, Mapping, Optional, Sequence, Tuple, Type, Union import pkg_resources from google.api_core import client_options as client_options_lib @@ -477,7 +477,6 @@ def list_instance_configs( r"""Lists the supported instance configurations for a given project. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 @@ -588,7 +587,6 @@ def get_instance_config( r"""Gets information about a particular instance configuration. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 @@ -931,7 +929,6 @@ def create_instance( is [Instance][google.spanner.admin.instance.v1.Instance], if successful. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 @@ -1115,7 +1112,6 @@ def update_instance( on resource [name][google.spanner.admin.instance.v1.Instance.name]. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 @@ -1261,7 +1257,6 @@ def delete_instance( irrevocably disappear from the API. All data in the databases is permanently deleted. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 @@ -1350,17 +1345,17 @@ def set_iam_policy( Authorization requires ``spanner.instances.setIamPolicy`` on [resource][google.iam.v1.SetIamPolicyRequest.resource]. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_set_iam_policy(): # Create a client client = spanner_admin_instance_v1.InstanceAdminClient() # Initialize request argument(s) - request = spanner_admin_instance_v1.SetIamPolicyRequest( + request = iam_policy_pb2.SetIamPolicyRequest( resource="resource_value", ) @@ -1391,21 +1386,26 @@ def sample_set_iam_policy(): Returns: google.iam.v1.policy_pb2.Policy: - Defines an Identity and Access Management (IAM) policy. It is used to - specify access control policies for Cloud Platform - resources. + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds - one or more members to a single role. Members can be - user accounts, service accounts, Google groups, and - domains (such as G Suite). A role is a named list of - permissions (defined by IAM or configured by users). - A binding can optionally specify a condition, which - is a logic expression that further constrains the - role binding based on attributes about the request - and/or target resource. - - **JSON Example** + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** { "bindings": [ @@ -1420,17 +1420,17 @@ def sample_set_iam_policy(): }, { "role": "roles/resourcemanager.organizationViewer", - "members": ["user:eve@example.com"], + "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } - ] + ], "etag": "BwWWja0YfJA=", "version": 3 } - **YAML Example** + **YAML example:** bindings: - members: - user:\ mike@example.com - group:\ admins@example.com - domain:google.com - @@ -1441,11 +1441,12 @@ def sample_set_iam_policy(): condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') + timestamp('2020-10-01T00:00:00.000Z') etag: + BwWWja0YfJA= version: 3 For a description of IAM and its features, see the - [IAM developer's - guide](\ https://cloud.google.com/iam/docs). + [IAM + documentation](\ https://cloud.google.com/iam/docs/). """ # Create or coerce a protobuf request object. @@ -1505,17 +1506,17 @@ def get_iam_policy( Authorization requires ``spanner.instances.getIamPolicy`` on [resource][google.iam.v1.GetIamPolicyRequest.resource]. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_get_iam_policy(): # Create a client client = spanner_admin_instance_v1.InstanceAdminClient() # Initialize request argument(s) - request = spanner_admin_instance_v1.GetIamPolicyRequest( + request = iam_policy_pb2.GetIamPolicyRequest( resource="resource_value", ) @@ -1546,21 +1547,26 @@ def sample_get_iam_policy(): Returns: google.iam.v1.policy_pb2.Policy: - Defines an Identity and Access Management (IAM) policy. It is used to - specify access control policies for Cloud Platform - resources. + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds - one or more members to a single role. Members can be - user accounts, service accounts, Google groups, and - domains (such as G Suite). A role is a named list of - permissions (defined by IAM or configured by users). - A binding can optionally specify a condition, which - is a logic expression that further constrains the - role binding based on attributes about the request - and/or target resource. - - **JSON Example** + one or more members, or principals, to a single role. + Principals can be user accounts, service accounts, + Google groups, and domains (such as G Suite). A role + is a named list of permissions; each role can be an + IAM predefined role or a user-created custom role. + + For some types of Google Cloud resources, a binding + can also specify a condition, which is a logical + expression that allows access to a resource only if + the expression evaluates to true. A condition can add + constraints based on attributes of the request, the + resource, or both. To learn which resources support + conditions in their IAM policies, see the [IAM + documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). + + **JSON example:** { "bindings": [ @@ -1575,17 +1581,17 @@ def sample_get_iam_policy(): }, { "role": "roles/resourcemanager.organizationViewer", - "members": ["user:eve@example.com"], + "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } - ] + ], "etag": "BwWWja0YfJA=", "version": 3 } - **YAML Example** + **YAML example:** bindings: - members: - user:\ mike@example.com - group:\ admins@example.com - domain:google.com - @@ -1596,11 +1602,12 @@ def sample_get_iam_policy(): condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') + timestamp('2020-10-01T00:00:00.000Z') etag: + BwWWja0YfJA= version: 3 For a description of IAM and its features, see the - [IAM developer's - guide](\ https://cloud.google.com/iam/docs). + [IAM + documentation](\ https://cloud.google.com/iam/docs/). """ # Create or coerce a protobuf request object. @@ -1662,17 +1669,17 @@ def test_iam_permissions( ``spanner.instances.list`` permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions. - .. code-block:: python from google.cloud import spanner_admin_instance_v1 + from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_test_iam_permissions(): # Create a client client = spanner_admin_instance_v1.InstanceAdminClient() # Initialize request argument(s) - request = spanner_admin_instance_v1.TestIamPermissionsRequest( + request = iam_policy_pb2.TestIamPermissionsRequest( resource="resource_value", permissions=['permissions_value_1', 'permissions_value_2'], ) diff --git a/google/cloud/spanner_admin_instance_v1/services/instance_admin/transports/base.py b/google/cloud/spanner_admin_instance_v1/services/instance_admin/transports/base.py index 3f9888c363..bff88baf0c 100644 --- a/google/cloud/spanner_admin_instance_v1/services/instance_admin/transports/base.py +++ b/google/cloud/spanner_admin_instance_v1/services/instance_admin/transports/base.py @@ -88,6 +88,7 @@ def __init__( always_use_jwt_access (Optional[bool]): Whether self signed JWT should be used for service account credentials. """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. if ":" not in host: host += ":443" @@ -358,5 +359,9 @@ def test_iam_permissions( ]: raise NotImplementedError() + @property + def kind(self) -> str: + raise NotImplementedError() + __all__ = ("InstanceAdminTransport",) diff --git a/google/cloud/spanner_admin_instance_v1/services/instance_admin/transports/grpc.py b/google/cloud/spanner_admin_instance_v1/services/instance_admin/transports/grpc.py index 012c2dce2e..1cb4b3d6ba 100644 --- a/google/cloud/spanner_admin_instance_v1/services/instance_admin/transports/grpc.py +++ b/google/cloud/spanner_admin_instance_v1/services/instance_admin/transports/grpc.py @@ -656,5 +656,9 @@ def test_iam_permissions( def close(self): self.grpc_channel.close() + @property + def kind(self) -> str: + return "grpc" + __all__ = ("InstanceAdminGrpcTransport",) diff --git a/google/cloud/spanner_admin_instance_v1/types/spanner_instance_admin.py b/google/cloud/spanner_admin_instance_v1/types/spanner_instance_admin.py index 5b964a7935..c4434b53b8 100644 --- a/google/cloud/spanner_admin_instance_v1/types/spanner_instance_admin.py +++ b/google/cloud/spanner_admin_instance_v1/types/spanner_instance_admin.py @@ -167,7 +167,7 @@ class Instance(proto.Message): the state must be either omitted or set to ``CREATING``. For [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be either omitted or set to ``READY``. - labels (Sequence[google.cloud.spanner_admin_instance_v1.types.Instance.LabelsEntry]): + labels (Mapping[str, str]): Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. diff --git a/google/cloud/spanner_v1/services/spanner/async_client.py b/google/cloud/spanner_v1/services/spanner/async_client.py index a9dc85cb22..e831c1c9b4 100644 --- a/google/cloud/spanner_v1/services/spanner/async_client.py +++ b/google/cloud/spanner_v1/services/spanner/async_client.py @@ -18,6 +18,7 @@ import re from typing import ( Dict, + Mapping, Optional, AsyncIterable, Awaitable, @@ -244,7 +245,6 @@ async def create_session( Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., ``"SELECT 1"``. - .. code-block:: python from google.cloud import spanner_v1 @@ -351,7 +351,6 @@ async def batch_create_sessions( the clients. See https://goo.gl/TgSFN2 for best practices on session cache management. - .. code-block:: python from google.cloud import spanner_v1 @@ -473,7 +472,6 @@ async def get_session( exist. This is mainly useful for determining whether a session is still alive. - .. code-block:: python from google.cloud import spanner_v1 @@ -695,7 +693,6 @@ async def delete_session( with it. This will asynchronously trigger cancellation of any operations that are running with this session. - .. code-block:: python from google.cloud import spanner_v1 @@ -800,7 +797,6 @@ async def execute_sql( [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] instead. - .. code-block:: python from google.cloud import spanner_v1 @@ -890,7 +886,6 @@ def execute_streaming_sql( individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. - .. code-block:: python from google.cloud import spanner_v1 @@ -983,7 +978,6 @@ async def execute_batch_dml( Execution stops after the first failed statement; the remaining statements are not executed. - .. code-block:: python from google.cloud import spanner_v1 @@ -1122,7 +1116,6 @@ async def read( calling [StreamingRead][google.spanner.v1.Spanner.StreamingRead] instead. - .. code-block:: python from google.cloud import spanner_v1 @@ -1213,7 +1206,6 @@ def streaming_read( the result set can exceed 100 MiB, and no column value can exceed 10 MiB. - .. code-block:: python from google.cloud import spanner_v1 @@ -1300,7 +1292,6 @@ async def begin_transaction( [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect. - .. code-block:: python from google.cloud import spanner_v1 @@ -1430,7 +1421,6 @@ async def commit( perform another read from the database to see the state of things as they are now. - .. code-block:: python from google.cloud import spanner_v1 @@ -1585,7 +1575,6 @@ async def rollback( transaction is not found. ``Rollback`` never returns ``ABORTED``. - .. code-block:: python from google.cloud import spanner_v1 @@ -1700,7 +1689,6 @@ async def partition_query( to resume the query, and the whole operation must be restarted from the beginning. - .. code-block:: python from google.cloud import spanner_v1 @@ -1801,7 +1789,6 @@ async def partition_read( to resume the read, and the whole operation must be restarted from the beginning. - .. code-block:: python from google.cloud import spanner_v1 diff --git a/google/cloud/spanner_v1/services/spanner/client.py b/google/cloud/spanner_v1/services/spanner/client.py index 42fb0a9a9c..a9203fb6a3 100644 --- a/google/cloud/spanner_v1/services/spanner/client.py +++ b/google/cloud/spanner_v1/services/spanner/client.py @@ -16,7 +16,7 @@ from collections import OrderedDict import os import re -from typing import Dict, Optional, Iterable, Sequence, Tuple, Type, Union +from typing import Dict, Mapping, Optional, Iterable, Sequence, Tuple, Type, Union import pkg_resources from google.api_core import client_options as client_options_lib @@ -487,7 +487,6 @@ def create_session( Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., ``"SELECT 1"``. - .. code-block:: python from google.cloud import spanner_v1 @@ -585,7 +584,6 @@ def batch_create_sessions( the clients. See https://goo.gl/TgSFN2 for best practices on session cache management. - .. code-block:: python from google.cloud import spanner_v1 @@ -698,7 +696,6 @@ def get_session( exist. This is mainly useful for determining whether a session is still alive. - .. code-block:: python from google.cloud import spanner_v1 @@ -902,7 +899,6 @@ def delete_session( with it. This will asynchronously trigger cancellation of any operations that are running with this session. - .. code-block:: python from google.cloud import spanner_v1 @@ -998,7 +994,6 @@ def execute_sql( [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] instead. - .. code-block:: python from google.cloud import spanner_v1 @@ -1080,7 +1075,6 @@ def execute_streaming_sql( individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. - .. code-block:: python from google.cloud import spanner_v1 @@ -1174,7 +1168,6 @@ def execute_batch_dml( Execution stops after the first failed statement; the remaining statements are not executed. - .. code-block:: python from google.cloud import spanner_v1 @@ -1305,7 +1298,6 @@ def read( calling [StreamingRead][google.spanner.v1.Spanner.StreamingRead] instead. - .. code-block:: python from google.cloud import spanner_v1 @@ -1388,7 +1380,6 @@ def streaming_read( the result set can exceed 100 MiB, and no column value can exceed 10 MiB. - .. code-block:: python from google.cloud import spanner_v1 @@ -1476,7 +1467,6 @@ def begin_transaction( [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect. - .. code-block:: python from google.cloud import spanner_v1 @@ -1597,7 +1587,6 @@ def commit( perform another read from the database to see the state of things as they are now. - .. code-block:: python from google.cloud import spanner_v1 @@ -1743,7 +1732,6 @@ def rollback( transaction is not found. ``Rollback`` never returns ``ABORTED``. - .. code-block:: python from google.cloud import spanner_v1 @@ -1849,7 +1837,6 @@ def partition_query( to resume the query, and the whole operation must be restarted from the beginning. - .. code-block:: python from google.cloud import spanner_v1 @@ -1942,7 +1929,6 @@ def partition_read( to resume the read, and the whole operation must be restarted from the beginning. - .. code-block:: python from google.cloud import spanner_v1 diff --git a/google/cloud/spanner_v1/services/spanner/transports/base.py b/google/cloud/spanner_v1/services/spanner/transports/base.py index 0066447c79..608c894a9a 100644 --- a/google/cloud/spanner_v1/services/spanner/transports/base.py +++ b/google/cloud/spanner_v1/services/spanner/transports/base.py @@ -87,6 +87,7 @@ def __init__( always_use_jwt_access (Optional[bool]): Whether self signed JWT should be used for service account credentials. """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. if ":" not in host: host += ":443" @@ -470,5 +471,9 @@ def partition_read( ]: raise NotImplementedError() + @property + def kind(self) -> str: + raise NotImplementedError() + __all__ = ("SpannerTransport",) diff --git a/google/cloud/spanner_v1/services/spanner/transports/grpc.py b/google/cloud/spanner_v1/services/spanner/transports/grpc.py index ba84345989..86a3ca9967 100644 --- a/google/cloud/spanner_v1/services/spanner/transports/grpc.py +++ b/google/cloud/spanner_v1/services/spanner/transports/grpc.py @@ -754,5 +754,9 @@ def partition_read( def close(self): self.grpc_channel.close() + @property + def kind(self) -> str: + return "grpc" + __all__ = ("SpannerGrpcTransport",) diff --git a/google/cloud/spanner_v1/types/__init__.py b/google/cloud/spanner_v1/types/__init__.py index 1ad35d70ed..c8d97aa910 100644 --- a/google/cloud/spanner_v1/types/__init__.py +++ b/google/cloud/spanner_v1/types/__init__.py @@ -13,12 +13,16 @@ # See the License for the specific language governing permissions and # limitations under the License. # -from .commit_response import CommitResponse +from .commit_response import ( + CommitResponse, +) from .keys import ( KeyRange, KeySet, ) -from .mutation import Mutation +from .mutation import ( + Mutation, +) from .query_plan import ( PlanNode, QueryPlan, diff --git a/google/cloud/spanner_v1/types/query_plan.py b/google/cloud/spanner_v1/types/query_plan.py index 76467cf6ab..465e9972be 100644 --- a/google/cloud/spanner_v1/types/query_plan.py +++ b/google/cloud/spanner_v1/types/query_plan.py @@ -126,7 +126,7 @@ class ShortRepresentation(proto.Message): description (str): A string representation of the expression subtree rooted at this node. - subqueries (Sequence[google.cloud.spanner_v1.types.PlanNode.ShortRepresentation.SubqueriesEntry]): + subqueries (Mapping[str, int]): A mapping of (subquery variable name) -> (subquery node id) for cases where the ``description`` string of this node references a ``SCALAR`` subquery contained in the expression diff --git a/google/cloud/spanner_v1/types/spanner.py b/google/cloud/spanner_v1/types/spanner.py index 2a94ded3fe..f6cacdc323 100644 --- a/google/cloud/spanner_v1/types/spanner.py +++ b/google/cloud/spanner_v1/types/spanner.py @@ -135,7 +135,7 @@ class Session(proto.Message): name (str): Output only. The name of the session. This is always system-assigned. - labels (Sequence[google.cloud.spanner_v1.types.Session.LabelsEntry]): + labels (Mapping[str, str]): The labels for the session. - Label keys must be between 1 and 63 characters long and @@ -398,7 +398,7 @@ class ExecuteSqlRequest(proto.Message): It is an error to execute a SQL statement with unbound parameters. - param_types (Sequence[google.cloud.spanner_v1.types.ExecuteSqlRequest.ParamTypesEntry]): + param_types (Mapping[str, google.cloud.spanner_v1.types.Type]): It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type ``BYTES`` and values of type ``STRING`` both appear in @@ -645,7 +645,7 @@ class Statement(proto.Message): It is an error to execute a SQL statement with unbound parameters. - param_types (Sequence[google.cloud.spanner_v1.types.ExecuteBatchDmlRequest.Statement.ParamTypesEntry]): + param_types (Mapping[str, google.cloud.spanner_v1.types.Type]): It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type ``BYTES`` and values of type ``STRING`` both appear in @@ -845,7 +845,7 @@ class PartitionQueryRequest(proto.Message): It is an error to execute a SQL statement with unbound parameters. - param_types (Sequence[google.cloud.spanner_v1.types.PartitionQueryRequest.ParamTypesEntry]): + param_types (Mapping[str, google.cloud.spanner_v1.types.Type]): It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type ``BYTES`` and values of type ``STRING`` both appear in diff --git a/samples/generated_samples/snippet_metadata_spanner admin database_v1.json b/samples/generated_samples/snippet_metadata_spanner admin database_v1.json index 5564ff3d37..8487879c25 100644 --- a/samples/generated_samples/snippet_metadata_spanner admin database_v1.json +++ b/samples/generated_samples/snippet_metadata_spanner admin database_v1.json @@ -1,16 +1,73 @@ { + "clientLibrary": { + "apis": [ + { + "id": "google.spanner.admin.database.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-cloud-spanner-admin-database" + }, "snippets": [ { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.copy_backup", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "CopyBackup" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.CopyBackupRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "backup_id", + "type": "str" + }, + { + "name": "source_backup", + "type": "str" + }, + { + "name": "expire_time", + "type": "google.protobuf.timestamp_pb2.Timestamp" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "copy_backup" }, + "description": "Sample for CopyBackup", "file": "spanner_v1_generated_database_admin_copy_backup_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_CopyBackup_async", "segments": [ { @@ -43,18 +100,66 @@ "start": 48, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_copy_backup_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.copy_backup", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "CopyBackup" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.CopyBackupRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "backup_id", + "type": "str" + }, + { + "name": "source_backup", + "type": "str" + }, + { + "name": "expire_time", + "type": "google.protobuf.timestamp_pb2.Timestamp" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "copy_backup" }, + "description": "Sample for CopyBackup", "file": "spanner_v1_generated_database_admin_copy_backup_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_CopyBackup_sync", "segments": [ { @@ -87,19 +192,63 @@ "start": 48, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_copy_backup_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.create_backup", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "CreateBackup" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.CreateBackupRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "backup", + "type": "google.cloud.spanner_admin_database_v1.types.Backup" + }, + { + "name": "backup_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "create_backup" }, + "description": "Sample for CreateBackup", "file": "spanner_v1_generated_database_admin_create_backup_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_CreateBackup_async", "segments": [ { @@ -132,18 +281,62 @@ "start": 47, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_create_backup_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.create_backup", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "CreateBackup" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.CreateBackupRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "backup", + "type": "google.cloud.spanner_admin_database_v1.types.Backup" + }, + { + "name": "backup_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "create_backup" }, + "description": "Sample for CreateBackup", "file": "spanner_v1_generated_database_admin_create_backup_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_CreateBackup_sync", "segments": [ { @@ -176,19 +369,59 @@ "start": 47, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_create_backup_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.create_database", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "CreateDatabase" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.CreateDatabaseRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "create_statement", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "create_database" }, + "description": "Sample for CreateDatabase", "file": "spanner_v1_generated_database_admin_create_database_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_CreateDatabase_async", "segments": [ { @@ -221,18 +454,58 @@ "start": 47, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_create_database_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.create_database", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "CreateDatabase" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.CreateDatabaseRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "create_statement", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "create_database" }, + "description": "Sample for CreateDatabase", "file": "spanner_v1_generated_database_admin_create_database_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_CreateDatabase_sync", "segments": [ { @@ -265,19 +538,54 @@ "start": 47, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_create_database_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.delete_backup", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "DeleteBackup" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.DeleteBackupRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_backup" }, + "description": "Sample for DeleteBackup", "file": "spanner_v1_generated_database_admin_delete_backup_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_DeleteBackup_async", "segments": [ { @@ -308,18 +616,53 @@ "end": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_delete_backup_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.delete_backup", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "DeleteBackup" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.DeleteBackupRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_backup" }, + "description": "Sample for DeleteBackup", "file": "spanner_v1_generated_database_admin_delete_backup_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_DeleteBackup_sync", "segments": [ { @@ -350,19 +693,54 @@ "end": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_delete_backup_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.drop_database", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "DropDatabase" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.DropDatabaseRequest" + }, + { + "name": "database", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "drop_database" }, + "description": "Sample for DropDatabase", "file": "spanner_v1_generated_database_admin_drop_database_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_DropDatabase_async", "segments": [ { @@ -393,18 +771,53 @@ "end": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_drop_database_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.drop_database", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "DropDatabase" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.DropDatabaseRequest" + }, + { + "name": "database", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "drop_database" }, + "description": "Sample for DropDatabase", "file": "spanner_v1_generated_database_admin_drop_database_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_DropDatabase_sync", "segments": [ { @@ -435,19 +848,55 @@ "end": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_drop_database_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.get_backup", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.GetBackup", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "GetBackup" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.GetBackupRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.types.Backup", + "shortName": "get_backup" }, + "description": "Sample for GetBackup", "file": "spanner_v1_generated_database_admin_get_backup_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_GetBackup_async", "segments": [ { @@ -480,18 +929,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_get_backup_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.get_backup", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.GetBackup", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "GetBackup" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.GetBackupRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.types.Backup", + "shortName": "get_backup" }, + "description": "Sample for GetBackup", "file": "spanner_v1_generated_database_admin_get_backup_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_GetBackup_sync", "segments": [ { @@ -524,19 +1009,55 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_get_backup_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.get_database_ddl", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "GetDatabaseDdl" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.GetDatabaseDdlRequest" + }, + { + "name": "database", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.types.GetDatabaseDdlResponse", + "shortName": "get_database_ddl" }, + "description": "Sample for GetDatabaseDdl", "file": "spanner_v1_generated_database_admin_get_database_ddl_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_GetDatabaseDdl_async", "segments": [ { @@ -569,18 +1090,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_get_database_ddl_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.get_database_ddl", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "GetDatabaseDdl" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.GetDatabaseDdlRequest" + }, + { + "name": "database", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.types.GetDatabaseDdlResponse", + "shortName": "get_database_ddl" }, + "description": "Sample for GetDatabaseDdl", "file": "spanner_v1_generated_database_admin_get_database_ddl_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_GetDatabaseDdl_sync", "segments": [ { @@ -613,19 +1170,55 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_get_database_ddl_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.get_database", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "GetDatabase" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.GetDatabaseRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.types.Database", + "shortName": "get_database" }, + "description": "Sample for GetDatabase", "file": "spanner_v1_generated_database_admin_get_database_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_GetDatabase_async", "segments": [ { @@ -658,18 +1251,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_get_database_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.get_database", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "GetDatabase" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.GetDatabaseRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.types.Database", + "shortName": "get_database" }, + "description": "Sample for GetDatabase", "file": "spanner_v1_generated_database_admin_get_database_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_GetDatabase_sync", "segments": [ { @@ -702,108 +1331,216 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_get_database_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.get_iam_policy", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.GetIamPolicy", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "GetIamPolicy" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.GetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "get_iam_policy" }, + "description": "Sample for GetIamPolicy", "file": "spanner_v1_generated_database_admin_get_iam_policy_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_GetIamPolicy_async", "segments": [ { - "end": 44, + "end": 45, "start": 27, "type": "FULL" }, { - "end": 44, + "end": 45, "start": 27, "type": "SHORT" }, { - "end": 33, - "start": 31, + "end": 34, + "start": 32, "type": "CLIENT_INITIALIZATION" }, { - "end": 38, - "start": 34, + "end": 39, + "start": 35, "type": "REQUEST_INITIALIZATION" }, { - "end": 41, - "start": 39, + "end": 42, + "start": 40, "type": "REQUEST_EXECUTION" }, { - "end": 45, - "start": 42, + "end": 46, + "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_get_iam_policy_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.get_iam_policy", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.GetIamPolicy", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "GetIamPolicy" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.GetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "get_iam_policy" }, + "description": "Sample for GetIamPolicy", "file": "spanner_v1_generated_database_admin_get_iam_policy_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_GetIamPolicy_sync", "segments": [ { - "end": 44, + "end": 45, "start": 27, "type": "FULL" }, { - "end": 44, + "end": 45, "start": 27, "type": "SHORT" }, { - "end": 33, - "start": 31, + "end": 34, + "start": 32, "type": "CLIENT_INITIALIZATION" }, { - "end": 38, - "start": 34, + "end": 39, + "start": 35, "type": "REQUEST_INITIALIZATION" }, { - "end": 41, - "start": 39, + "end": 42, + "start": 40, "type": "REQUEST_EXECUTION" }, { - "end": 45, - "start": 42, + "end": 46, + "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_get_iam_policy_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.list_backup_operations", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "ListBackupOperations" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.ListBackupOperationsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsAsyncPager", + "shortName": "list_backup_operations" }, + "description": "Sample for ListBackupOperations", "file": "spanner_v1_generated_database_admin_list_backup_operations_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_ListBackupOperations_async", "segments": [ { @@ -836,18 +1573,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_list_backup_operations_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.list_backup_operations", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "ListBackupOperations" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.ListBackupOperationsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsPager", + "shortName": "list_backup_operations" }, + "description": "Sample for ListBackupOperations", "file": "spanner_v1_generated_database_admin_list_backup_operations_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_ListBackupOperations_sync", "segments": [ { @@ -880,19 +1653,55 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_list_backup_operations_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.list_backups", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.ListBackups", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "ListBackups" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.ListBackupsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsAsyncPager", + "shortName": "list_backups" }, + "description": "Sample for ListBackups", "file": "spanner_v1_generated_database_admin_list_backups_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_ListBackups_async", "segments": [ { @@ -925,18 +1734,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_list_backups_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.list_backups", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.ListBackups", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "ListBackups" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.ListBackupsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsPager", + "shortName": "list_backups" }, + "description": "Sample for ListBackups", "file": "spanner_v1_generated_database_admin_list_backups_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_ListBackups_sync", "segments": [ { @@ -969,19 +1814,55 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_list_backups_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.list_database_operations", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "ListDatabaseOperations" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.ListDatabaseOperationsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsAsyncPager", + "shortName": "list_database_operations" }, + "description": "Sample for ListDatabaseOperations", "file": "spanner_v1_generated_database_admin_list_database_operations_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_ListDatabaseOperations_async", "segments": [ { @@ -1014,18 +1895,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_list_database_operations_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.list_database_operations", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "ListDatabaseOperations" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.ListDatabaseOperationsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsPager", + "shortName": "list_database_operations" }, + "description": "Sample for ListDatabaseOperations", "file": "spanner_v1_generated_database_admin_list_database_operations_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_ListDatabaseOperations_sync", "segments": [ { @@ -1058,19 +1975,55 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_list_database_operations_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.list_databases", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "ListDatabases" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.ListDatabasesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesAsyncPager", + "shortName": "list_databases" }, + "description": "Sample for ListDatabases", "file": "spanner_v1_generated_database_admin_list_databases_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_ListDatabases_async", "segments": [ { @@ -1103,18 +2056,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_list_databases_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.list_databases", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "ListDatabases" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.ListDatabasesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesPager", + "shortName": "list_databases" }, + "description": "Sample for ListDatabases", "file": "spanner_v1_generated_database_admin_list_databases_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_ListDatabases_sync", "segments": [ { @@ -1147,19 +2136,63 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_list_databases_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.restore_database", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "RestoreDatabase" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.RestoreDatabaseRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "database_id", + "type": "str" + }, + { + "name": "backup", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "restore_database" }, + "description": "Sample for RestoreDatabase", "file": "spanner_v1_generated_database_admin_restore_database_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_RestoreDatabase_async", "segments": [ { @@ -1192,18 +2225,62 @@ "start": 48, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_restore_database_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.restore_database", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "RestoreDatabase" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.RestoreDatabaseRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "database_id", + "type": "str" + }, + { + "name": "backup", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "restore_database" }, + "description": "Sample for RestoreDatabase", "file": "spanner_v1_generated_database_admin_restore_database_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_RestoreDatabase_sync", "segments": [ { @@ -1236,197 +2313,389 @@ "start": 48, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_restore_database_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.set_iam_policy", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.SetIamPolicy", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "SetIamPolicy" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.SetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "set_iam_policy" }, + "description": "Sample for SetIamPolicy", "file": "spanner_v1_generated_database_admin_set_iam_policy_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_SetIamPolicy_async", "segments": [ { - "end": 44, + "end": 45, "start": 27, "type": "FULL" }, { - "end": 44, + "end": 45, "start": 27, "type": "SHORT" }, { - "end": 33, - "start": 31, + "end": 34, + "start": 32, "type": "CLIENT_INITIALIZATION" }, { - "end": 38, - "start": 34, + "end": 39, + "start": 35, "type": "REQUEST_INITIALIZATION" }, { - "end": 41, - "start": 39, + "end": 42, + "start": 40, "type": "REQUEST_EXECUTION" }, { - "end": 45, - "start": 42, + "end": 46, + "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_set_iam_policy_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.set_iam_policy", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.SetIamPolicy", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "SetIamPolicy" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.SetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "set_iam_policy" }, + "description": "Sample for SetIamPolicy", "file": "spanner_v1_generated_database_admin_set_iam_policy_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_SetIamPolicy_sync", "segments": [ { - "end": 44, + "end": 45, "start": 27, "type": "FULL" }, { - "end": 44, + "end": 45, "start": 27, "type": "SHORT" }, { - "end": 33, - "start": 31, + "end": 34, + "start": 32, "type": "CLIENT_INITIALIZATION" }, { - "end": 38, - "start": 34, + "end": 39, + "start": 35, "type": "REQUEST_INITIALIZATION" }, { - "end": 41, - "start": 39, + "end": 42, + "start": 40, "type": "REQUEST_EXECUTION" }, { - "end": 45, - "start": 42, + "end": 46, + "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_set_iam_policy_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.test_iam_permissions", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.TestIamPermissions", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "TestIamPermissions" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "permissions", + "type": "Sequence[str]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse", + "shortName": "test_iam_permissions" }, + "description": "Sample for TestIamPermissions", "file": "spanner_v1_generated_database_admin_test_iam_permissions_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_TestIamPermissions_async", "segments": [ { - "end": 45, + "end": 46, "start": 27, "type": "FULL" }, { - "end": 45, + "end": 46, "start": 27, "type": "SHORT" }, { - "end": 33, - "start": 31, + "end": 34, + "start": 32, "type": "CLIENT_INITIALIZATION" }, { - "end": 39, - "start": 34, + "end": 40, + "start": 35, "type": "REQUEST_INITIALIZATION" }, { - "end": 42, - "start": 40, + "end": 43, + "start": 41, "type": "REQUEST_EXECUTION" }, { - "end": 46, - "start": 43, + "end": 47, + "start": 44, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_test_iam_permissions_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.test_iam_permissions", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.TestIamPermissions", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "TestIamPermissions" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "permissions", + "type": "Sequence[str]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse", + "shortName": "test_iam_permissions" }, + "description": "Sample for TestIamPermissions", "file": "spanner_v1_generated_database_admin_test_iam_permissions_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_TestIamPermissions_sync", "segments": [ { - "end": 45, + "end": 46, "start": 27, "type": "FULL" }, { - "end": 45, + "end": 46, "start": 27, "type": "SHORT" }, { - "end": 33, - "start": 31, + "end": 34, + "start": 32, "type": "CLIENT_INITIALIZATION" }, { - "end": 39, - "start": 34, + "end": 40, + "start": 35, "type": "REQUEST_INITIALIZATION" }, { - "end": 42, - "start": 40, + "end": 43, + "start": 41, "type": "REQUEST_EXECUTION" }, { - "end": 46, - "start": 43, + "end": 47, + "start": 44, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_test_iam_permissions_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.update_backup", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "UpdateBackup" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.UpdateBackupRequest" + }, + { + "name": "backup", + "type": "google.cloud.spanner_admin_database_v1.types.Backup" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.types.Backup", + "shortName": "update_backup" }, + "description": "Sample for UpdateBackup", "file": "spanner_v1_generated_database_admin_update_backup_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_UpdateBackup_async", "segments": [ { @@ -1459,18 +2728,58 @@ "start": 41, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_update_backup_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.update_backup", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "UpdateBackup" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.UpdateBackupRequest" + }, + { + "name": "backup", + "type": "google.cloud.spanner_admin_database_v1.types.Backup" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_database_v1.types.Backup", + "shortName": "update_backup" }, + "description": "Sample for UpdateBackup", "file": "spanner_v1_generated_database_admin_update_backup_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_UpdateBackup_sync", "segments": [ { @@ -1503,19 +2812,59 @@ "start": 41, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_update_backup_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient", + "shortName": "DatabaseAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminAsyncClient.update_database_ddl", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "UpdateDatabaseDdl" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.UpdateDatabaseDdlRequest" + }, + { + "name": "database", + "type": "str" + }, + { + "name": "statements", + "type": "Sequence[str]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "update_database_ddl" }, + "description": "Sample for UpdateDatabaseDdl", "file": "spanner_v1_generated_database_admin_update_database_ddl_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_UpdateDatabaseDdl_async", "segments": [ { @@ -1548,18 +2897,58 @@ "start": 47, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_update_database_ddl_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient", + "shortName": "DatabaseAdminClient" + }, + "fullName": "google.cloud.spanner_admin_database_v1.DatabaseAdminClient.update_database_ddl", "method": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl", "service": { + "fullName": "google.spanner.admin.database.v1.DatabaseAdmin", "shortName": "DatabaseAdmin" }, "shortName": "UpdateDatabaseDdl" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_database_v1.types.UpdateDatabaseDdlRequest" + }, + { + "name": "database", + "type": "str" + }, + { + "name": "statements", + "type": "Sequence[str]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "update_database_ddl" }, + "description": "Sample for UpdateDatabaseDdl", "file": "spanner_v1_generated_database_admin_update_database_ddl_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_DatabaseAdmin_UpdateDatabaseDdl_sync", "segments": [ { @@ -1592,7 +2981,8 @@ "start": 47, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_database_admin_update_database_ddl_sync.py" } ] } diff --git a/samples/generated_samples/snippet_metadata_spanner admin instance_v1.json b/samples/generated_samples/snippet_metadata_spanner admin instance_v1.json index 07c69a762e..fbdf96b9c7 100644 --- a/samples/generated_samples/snippet_metadata_spanner admin instance_v1.json +++ b/samples/generated_samples/snippet_metadata_spanner admin instance_v1.json @@ -1,16 +1,69 @@ { + "clientLibrary": { + "apis": [ + { + "id": "google.spanner.admin.instance.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-cloud-spanner-admin-instance" + }, "snippets": [ { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient", + "shortName": "InstanceAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient.create_instance", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "CreateInstance" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_instance_v1.types.CreateInstanceRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "instance_id", + "type": "str" + }, + { + "name": "instance", + "type": "google.cloud.spanner_admin_instance_v1.types.Instance" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "create_instance" }, + "description": "Sample for CreateInstance", "file": "spanner_v1_generated_instance_admin_create_instance_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_CreateInstance_async", "segments": [ { @@ -43,18 +96,62 @@ "start": 53, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_create_instance_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient", + "shortName": "InstanceAdminClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient.create_instance", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "CreateInstance" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_instance_v1.types.CreateInstanceRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "instance_id", + "type": "str" + }, + { + "name": "instance", + "type": "google.cloud.spanner_admin_instance_v1.types.Instance" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "create_instance" }, + "description": "Sample for CreateInstance", "file": "spanner_v1_generated_instance_admin_create_instance_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_CreateInstance_sync", "segments": [ { @@ -87,19 +184,54 @@ "start": 53, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_create_instance_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient", + "shortName": "InstanceAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient.delete_instance", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstance", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "DeleteInstance" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_instance_v1.types.DeleteInstanceRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_instance" }, + "description": "Sample for DeleteInstance", "file": "spanner_v1_generated_instance_admin_delete_instance_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_DeleteInstance_async", "segments": [ { @@ -130,18 +262,53 @@ "end": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_delete_instance_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient", + "shortName": "InstanceAdminClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient.delete_instance", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstance", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "DeleteInstance" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_instance_v1.types.DeleteInstanceRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_instance" }, + "description": "Sample for DeleteInstance", "file": "spanner_v1_generated_instance_admin_delete_instance_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_DeleteInstance_sync", "segments": [ { @@ -172,108 +339,216 @@ "end": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_delete_instance_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient", + "shortName": "InstanceAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient.get_iam_policy", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.GetIamPolicy", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "GetIamPolicy" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.GetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "get_iam_policy" }, + "description": "Sample for GetIamPolicy", "file": "spanner_v1_generated_instance_admin_get_iam_policy_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_GetIamPolicy_async", "segments": [ { - "end": 44, + "end": 45, "start": 27, "type": "FULL" }, { - "end": 44, + "end": 45, "start": 27, "type": "SHORT" }, { - "end": 33, - "start": 31, + "end": 34, + "start": 32, "type": "CLIENT_INITIALIZATION" }, { - "end": 38, - "start": 34, + "end": 39, + "start": 35, "type": "REQUEST_INITIALIZATION" }, { - "end": 41, - "start": 39, + "end": 42, + "start": 40, "type": "REQUEST_EXECUTION" }, { - "end": 45, - "start": 42, + "end": 46, + "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_get_iam_policy_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient", + "shortName": "InstanceAdminClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient.get_iam_policy", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.GetIamPolicy", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "GetIamPolicy" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.GetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "get_iam_policy" }, + "description": "Sample for GetIamPolicy", "file": "spanner_v1_generated_instance_admin_get_iam_policy_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_GetIamPolicy_sync", "segments": [ { - "end": 44, + "end": 45, "start": 27, "type": "FULL" }, { - "end": 44, + "end": 45, "start": 27, "type": "SHORT" }, { - "end": 33, - "start": 31, + "end": 34, + "start": 32, "type": "CLIENT_INITIALIZATION" }, { - "end": 38, - "start": 34, + "end": 39, + "start": 35, "type": "REQUEST_INITIALIZATION" }, { - "end": 41, - "start": 39, + "end": 42, + "start": 40, "type": "REQUEST_EXECUTION" }, { - "end": 45, - "start": 42, + "end": 46, + "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_get_iam_policy_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient", + "shortName": "InstanceAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient.get_instance_config", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfig", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "GetInstanceConfig" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_instance_v1.types.GetInstanceConfigRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_instance_v1.types.InstanceConfig", + "shortName": "get_instance_config" }, + "description": "Sample for GetInstanceConfig", "file": "spanner_v1_generated_instance_admin_get_instance_config_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_GetInstanceConfig_async", "segments": [ { @@ -306,18 +581,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_get_instance_config_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient", + "shortName": "InstanceAdminClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient.get_instance_config", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfig", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "GetInstanceConfig" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_instance_v1.types.GetInstanceConfigRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_instance_v1.types.InstanceConfig", + "shortName": "get_instance_config" }, + "description": "Sample for GetInstanceConfig", "file": "spanner_v1_generated_instance_admin_get_instance_config_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_GetInstanceConfig_sync", "segments": [ { @@ -350,19 +661,55 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_get_instance_config_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient", + "shortName": "InstanceAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient.get_instance", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.GetInstance", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "GetInstance" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_instance_v1.types.GetInstanceRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_instance_v1.types.Instance", + "shortName": "get_instance" }, + "description": "Sample for GetInstance", "file": "spanner_v1_generated_instance_admin_get_instance_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_GetInstance_async", "segments": [ { @@ -395,18 +742,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_get_instance_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient", + "shortName": "InstanceAdminClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient.get_instance", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.GetInstance", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "GetInstance" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_instance_v1.types.GetInstanceRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_instance_v1.types.Instance", + "shortName": "get_instance" }, + "description": "Sample for GetInstance", "file": "spanner_v1_generated_instance_admin_get_instance_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_GetInstance_sync", "segments": [ { @@ -439,19 +822,55 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_get_instance_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient", + "shortName": "InstanceAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient.list_instance_configs", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "ListInstanceConfigs" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_instance_v1.types.ListInstanceConfigsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsAsyncPager", + "shortName": "list_instance_configs" }, + "description": "Sample for ListInstanceConfigs", "file": "spanner_v1_generated_instance_admin_list_instance_configs_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_ListInstanceConfigs_async", "segments": [ { @@ -484,18 +903,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_list_instance_configs_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient", + "shortName": "InstanceAdminClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient.list_instance_configs", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "ListInstanceConfigs" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_instance_v1.types.ListInstanceConfigsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsPager", + "shortName": "list_instance_configs" }, + "description": "Sample for ListInstanceConfigs", "file": "spanner_v1_generated_instance_admin_list_instance_configs_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_ListInstanceConfigs_sync", "segments": [ { @@ -528,19 +983,55 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_list_instance_configs_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient", + "shortName": "InstanceAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient.list_instances", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.ListInstances", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "ListInstances" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_instance_v1.types.ListInstancesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesAsyncPager", + "shortName": "list_instances" }, + "description": "Sample for ListInstances", "file": "spanner_v1_generated_instance_admin_list_instances_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_ListInstances_async", "segments": [ { @@ -573,18 +1064,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_list_instances_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient", + "shortName": "InstanceAdminClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient.list_instances", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.ListInstances", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "ListInstances" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_instance_v1.types.ListInstancesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesPager", + "shortName": "list_instances" }, + "description": "Sample for ListInstances", "file": "spanner_v1_generated_instance_admin_list_instances_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_ListInstances_sync", "segments": [ { @@ -617,197 +1144,389 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_list_instances_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient", + "shortName": "InstanceAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient.set_iam_policy", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.SetIamPolicy", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "SetIamPolicy" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.SetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "set_iam_policy" }, + "description": "Sample for SetIamPolicy", "file": "spanner_v1_generated_instance_admin_set_iam_policy_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_SetIamPolicy_async", "segments": [ { - "end": 44, + "end": 45, "start": 27, "type": "FULL" }, { - "end": 44, + "end": 45, "start": 27, "type": "SHORT" }, { - "end": 33, - "start": 31, + "end": 34, + "start": 32, "type": "CLIENT_INITIALIZATION" }, { - "end": 38, - "start": 34, + "end": 39, + "start": 35, "type": "REQUEST_INITIALIZATION" }, { - "end": 41, - "start": 39, + "end": 42, + "start": 40, "type": "REQUEST_EXECUTION" }, { - "end": 45, - "start": 42, + "end": 46, + "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_set_iam_policy_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient", + "shortName": "InstanceAdminClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient.set_iam_policy", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.SetIamPolicy", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "SetIamPolicy" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.SetIamPolicyRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.policy_pb2.Policy", + "shortName": "set_iam_policy" }, + "description": "Sample for SetIamPolicy", "file": "spanner_v1_generated_instance_admin_set_iam_policy_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_SetIamPolicy_sync", "segments": [ { - "end": 44, + "end": 45, "start": 27, "type": "FULL" }, { - "end": 44, + "end": 45, "start": 27, "type": "SHORT" }, { - "end": 33, - "start": 31, + "end": 34, + "start": 32, "type": "CLIENT_INITIALIZATION" }, { - "end": 38, - "start": 34, + "end": 39, + "start": 35, "type": "REQUEST_INITIALIZATION" }, { - "end": 41, - "start": 39, + "end": 42, + "start": 40, "type": "REQUEST_EXECUTION" }, { - "end": 45, - "start": 42, + "end": 46, + "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_set_iam_policy_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient", + "shortName": "InstanceAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient.test_iam_permissions", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.TestIamPermissions", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "TestIamPermissions" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "permissions", + "type": "Sequence[str]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse", + "shortName": "test_iam_permissions" }, + "description": "Sample for TestIamPermissions", "file": "spanner_v1_generated_instance_admin_test_iam_permissions_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_TestIamPermissions_async", "segments": [ { - "end": 45, + "end": 46, "start": 27, "type": "FULL" }, { - "end": 45, + "end": 46, "start": 27, "type": "SHORT" }, { - "end": 33, - "start": 31, + "end": 34, + "start": 32, "type": "CLIENT_INITIALIZATION" }, { - "end": 39, - "start": 34, + "end": 40, + "start": 35, "type": "REQUEST_INITIALIZATION" }, { - "end": 42, - "start": 40, + "end": 43, + "start": 41, "type": "REQUEST_EXECUTION" }, { - "end": 46, - "start": 43, + "end": 47, + "start": 44, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_test_iam_permissions_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient", + "shortName": "InstanceAdminClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient.test_iam_permissions", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.TestIamPermissions", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "TestIamPermissions" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest" + }, + { + "name": "resource", + "type": "str" + }, + { + "name": "permissions", + "type": "Sequence[str]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse", + "shortName": "test_iam_permissions" }, + "description": "Sample for TestIamPermissions", "file": "spanner_v1_generated_instance_admin_test_iam_permissions_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_TestIamPermissions_sync", "segments": [ { - "end": 45, + "end": 46, "start": 27, "type": "FULL" }, { - "end": 45, + "end": 46, "start": 27, "type": "SHORT" }, { - "end": 33, - "start": 31, + "end": 34, + "start": 32, "type": "CLIENT_INITIALIZATION" }, { - "end": 39, - "start": 34, + "end": 40, + "start": 35, "type": "REQUEST_INITIALIZATION" }, { - "end": 42, - "start": 40, + "end": 43, + "start": 41, "type": "REQUEST_EXECUTION" }, { - "end": 46, - "start": 43, + "end": 47, + "start": 44, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_test_iam_permissions_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient", + "shortName": "InstanceAdminAsyncClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminAsyncClient.update_instance", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "UpdateInstance" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_instance_v1.types.UpdateInstanceRequest" + }, + { + "name": "instance", + "type": "google.cloud.spanner_admin_instance_v1.types.Instance" + }, + { + "name": "field_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "update_instance" }, + "description": "Sample for UpdateInstance", "file": "spanner_v1_generated_instance_admin_update_instance_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_UpdateInstance_async", "segments": [ { @@ -840,18 +1559,58 @@ "start": 51, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_update_instance_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient", + "shortName": "InstanceAdminClient" + }, + "fullName": "google.cloud.spanner_admin_instance_v1.InstanceAdminClient.update_instance", "method": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance", "service": { + "fullName": "google.spanner.admin.instance.v1.InstanceAdmin", "shortName": "InstanceAdmin" }, "shortName": "UpdateInstance" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_admin_instance_v1.types.UpdateInstanceRequest" + }, + { + "name": "instance", + "type": "google.cloud.spanner_admin_instance_v1.types.Instance" + }, + { + "name": "field_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "update_instance" }, + "description": "Sample for UpdateInstance", "file": "spanner_v1_generated_instance_admin_update_instance_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_InstanceAdmin_UpdateInstance_sync", "segments": [ { @@ -884,7 +1643,8 @@ "start": 51, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_instance_admin_update_instance_sync.py" } ] } diff --git a/samples/generated_samples/snippet_metadata_spanner_v1.json b/samples/generated_samples/snippet_metadata_spanner_v1.json index 3303488e27..5eb8233307 100644 --- a/samples/generated_samples/snippet_metadata_spanner_v1.json +++ b/samples/generated_samples/snippet_metadata_spanner_v1.json @@ -1,16 +1,65 @@ { + "clientLibrary": { + "apis": [ + { + "id": "google.spanner.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-cloud-spanner" + }, "snippets": [ { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.batch_create_sessions", "method": { + "fullName": "google.spanner.v1.Spanner.BatchCreateSessions", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "BatchCreateSessions" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.BatchCreateSessionsRequest" + }, + { + "name": "database", + "type": "str" + }, + { + "name": "session_count", + "type": "int" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.BatchCreateSessionsResponse", + "shortName": "batch_create_sessions" }, + "description": "Sample for BatchCreateSessions", "file": "spanner_v1_generated_spanner_batch_create_sessions_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_BatchCreateSessions_async", "segments": [ { @@ -43,18 +92,58 @@ "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_batch_create_sessions_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.batch_create_sessions", "method": { + "fullName": "google.spanner.v1.Spanner.BatchCreateSessions", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "BatchCreateSessions" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.BatchCreateSessionsRequest" + }, + { + "name": "database", + "type": "str" + }, + { + "name": "session_count", + "type": "int" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.BatchCreateSessionsResponse", + "shortName": "batch_create_sessions" }, + "description": "Sample for BatchCreateSessions", "file": "spanner_v1_generated_spanner_batch_create_sessions_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_BatchCreateSessions_sync", "segments": [ { @@ -87,19 +176,59 @@ "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_batch_create_sessions_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.begin_transaction", "method": { + "fullName": "google.spanner.v1.Spanner.BeginTransaction", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "BeginTransaction" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.BeginTransactionRequest" + }, + { + "name": "session", + "type": "str" + }, + { + "name": "options", + "type": "google.cloud.spanner_v1.types.TransactionOptions" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.Transaction", + "shortName": "begin_transaction" }, + "description": "Sample for BeginTransaction", "file": "spanner_v1_generated_spanner_begin_transaction_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_BeginTransaction_async", "segments": [ { @@ -132,18 +261,58 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_begin_transaction_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.begin_transaction", "method": { + "fullName": "google.spanner.v1.Spanner.BeginTransaction", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "BeginTransaction" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.BeginTransactionRequest" + }, + { + "name": "session", + "type": "str" + }, + { + "name": "options", + "type": "google.cloud.spanner_v1.types.TransactionOptions" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.Transaction", + "shortName": "begin_transaction" }, + "description": "Sample for BeginTransaction", "file": "spanner_v1_generated_spanner_begin_transaction_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_BeginTransaction_sync", "segments": [ { @@ -176,19 +345,67 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_begin_transaction_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.commit", "method": { + "fullName": "google.spanner.v1.Spanner.Commit", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "Commit" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.CommitRequest" + }, + { + "name": "session", + "type": "str" + }, + { + "name": "transaction_id", + "type": "bytes" + }, + { + "name": "mutations", + "type": "Sequence[google.cloud.spanner_v1.types.Mutation]" + }, + { + "name": "single_use_transaction", + "type": "google.cloud.spanner_v1.types.TransactionOptions" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.CommitResponse", + "shortName": "commit" }, + "description": "Sample for Commit", "file": "spanner_v1_generated_spanner_commit_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_Commit_async", "segments": [ { @@ -221,18 +438,66 @@ "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_commit_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.commit", "method": { + "fullName": "google.spanner.v1.Spanner.Commit", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "Commit" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.CommitRequest" + }, + { + "name": "session", + "type": "str" + }, + { + "name": "transaction_id", + "type": "bytes" + }, + { + "name": "mutations", + "type": "Sequence[google.cloud.spanner_v1.types.Mutation]" + }, + { + "name": "single_use_transaction", + "type": "google.cloud.spanner_v1.types.TransactionOptions" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.CommitResponse", + "shortName": "commit" }, + "description": "Sample for Commit", "file": "spanner_v1_generated_spanner_commit_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_Commit_sync", "segments": [ { @@ -265,19 +530,55 @@ "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_commit_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.create_session", "method": { + "fullName": "google.spanner.v1.Spanner.CreateSession", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "CreateSession" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.CreateSessionRequest" + }, + { + "name": "database", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.Session", + "shortName": "create_session" }, + "description": "Sample for CreateSession", "file": "spanner_v1_generated_spanner_create_session_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_CreateSession_async", "segments": [ { @@ -310,18 +611,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_create_session_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.create_session", "method": { + "fullName": "google.spanner.v1.Spanner.CreateSession", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "CreateSession" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.CreateSessionRequest" + }, + { + "name": "database", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.Session", + "shortName": "create_session" }, + "description": "Sample for CreateSession", "file": "spanner_v1_generated_spanner_create_session_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_CreateSession_sync", "segments": [ { @@ -354,19 +691,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_create_session_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.delete_session", "method": { + "fullName": "google.spanner.v1.Spanner.DeleteSession", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "DeleteSession" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.DeleteSessionRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_session" }, + "description": "Sample for DeleteSession", "file": "spanner_v1_generated_spanner_delete_session_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_DeleteSession_async", "segments": [ { @@ -397,18 +769,53 @@ "end": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_delete_session_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.delete_session", "method": { + "fullName": "google.spanner.v1.Spanner.DeleteSession", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "DeleteSession" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.DeleteSessionRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_session" }, + "description": "Sample for DeleteSession", "file": "spanner_v1_generated_spanner_delete_session_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_DeleteSession_sync", "segments": [ { @@ -439,19 +846,51 @@ "end": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_delete_session_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.execute_batch_dml", "method": { + "fullName": "google.spanner.v1.Spanner.ExecuteBatchDml", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "ExecuteBatchDml" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.ExecuteBatchDmlRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.ExecuteBatchDmlResponse", + "shortName": "execute_batch_dml" }, + "description": "Sample for ExecuteBatchDml", "file": "spanner_v1_generated_spanner_execute_batch_dml_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_ExecuteBatchDml_async", "segments": [ { @@ -484,18 +923,50 @@ "start": 47, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_execute_batch_dml_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.execute_batch_dml", "method": { + "fullName": "google.spanner.v1.Spanner.ExecuteBatchDml", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "ExecuteBatchDml" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.ExecuteBatchDmlRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.ExecuteBatchDmlResponse", + "shortName": "execute_batch_dml" }, + "description": "Sample for ExecuteBatchDml", "file": "spanner_v1_generated_spanner_execute_batch_dml_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_ExecuteBatchDml_sync", "segments": [ { @@ -528,19 +999,51 @@ "start": 47, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_execute_batch_dml_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.execute_sql", "method": { + "fullName": "google.spanner.v1.Spanner.ExecuteSql", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "ExecuteSql" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.ExecuteSqlRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.ResultSet", + "shortName": "execute_sql" }, + "description": "Sample for ExecuteSql", "file": "spanner_v1_generated_spanner_execute_sql_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_ExecuteSql_async", "segments": [ { @@ -573,18 +1076,50 @@ "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_execute_sql_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.execute_sql", "method": { + "fullName": "google.spanner.v1.Spanner.ExecuteSql", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "ExecuteSql" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.ExecuteSqlRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.ResultSet", + "shortName": "execute_sql" }, + "description": "Sample for ExecuteSql", "file": "spanner_v1_generated_spanner_execute_sql_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_ExecuteSql_sync", "segments": [ { @@ -617,19 +1152,51 @@ "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_execute_sql_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.execute_streaming_sql", "method": { + "fullName": "google.spanner.v1.Spanner.ExecuteStreamingSql", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "ExecuteStreamingSql" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.ExecuteSqlRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "Iterable[google.cloud.spanner_v1.types.PartialResultSet]", + "shortName": "execute_streaming_sql" }, + "description": "Sample for ExecuteStreamingSql", "file": "spanner_v1_generated_spanner_execute_streaming_sql_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_ExecuteStreamingSql_async", "segments": [ { @@ -662,18 +1229,50 @@ "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_execute_streaming_sql_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.execute_streaming_sql", "method": { + "fullName": "google.spanner.v1.Spanner.ExecuteStreamingSql", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "ExecuteStreamingSql" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.ExecuteSqlRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "Iterable[google.cloud.spanner_v1.types.PartialResultSet]", + "shortName": "execute_streaming_sql" }, + "description": "Sample for ExecuteStreamingSql", "file": "spanner_v1_generated_spanner_execute_streaming_sql_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_ExecuteStreamingSql_sync", "segments": [ { @@ -706,19 +1305,55 @@ "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_execute_streaming_sql_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.get_session", "method": { + "fullName": "google.spanner.v1.Spanner.GetSession", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "GetSession" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.GetSessionRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.Session", + "shortName": "get_session" }, + "description": "Sample for GetSession", "file": "spanner_v1_generated_spanner_get_session_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_GetSession_async", "segments": [ { @@ -751,18 +1386,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_get_session_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.get_session", "method": { + "fullName": "google.spanner.v1.Spanner.GetSession", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "GetSession" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.GetSessionRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.Session", + "shortName": "get_session" }, + "description": "Sample for GetSession", "file": "spanner_v1_generated_spanner_get_session_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_GetSession_sync", "segments": [ { @@ -795,19 +1466,55 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_get_session_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.list_sessions", "method": { + "fullName": "google.spanner.v1.Spanner.ListSessions", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "ListSessions" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.ListSessionsRequest" + }, + { + "name": "database", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.services.spanner.pagers.ListSessionsAsyncPager", + "shortName": "list_sessions" }, + "description": "Sample for ListSessions", "file": "spanner_v1_generated_spanner_list_sessions_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_ListSessions_async", "segments": [ { @@ -840,18 +1547,54 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_list_sessions_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.list_sessions", "method": { + "fullName": "google.spanner.v1.Spanner.ListSessions", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "ListSessions" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.ListSessionsRequest" + }, + { + "name": "database", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.services.spanner.pagers.ListSessionsPager", + "shortName": "list_sessions" }, + "description": "Sample for ListSessions", "file": "spanner_v1_generated_spanner_list_sessions_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_ListSessions_sync", "segments": [ { @@ -884,19 +1627,51 @@ "start": 42, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_list_sessions_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.partition_query", "method": { + "fullName": "google.spanner.v1.Spanner.PartitionQuery", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "PartitionQuery" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.PartitionQueryRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.PartitionResponse", + "shortName": "partition_query" }, + "description": "Sample for PartitionQuery", "file": "spanner_v1_generated_spanner_partition_query_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_PartitionQuery_async", "segments": [ { @@ -929,18 +1704,50 @@ "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_partition_query_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.partition_query", "method": { + "fullName": "google.spanner.v1.Spanner.PartitionQuery", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "PartitionQuery" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.PartitionQueryRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.PartitionResponse", + "shortName": "partition_query" }, + "description": "Sample for PartitionQuery", "file": "spanner_v1_generated_spanner_partition_query_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_PartitionQuery_sync", "segments": [ { @@ -973,19 +1780,51 @@ "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_partition_query_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.partition_read", "method": { + "fullName": "google.spanner.v1.Spanner.PartitionRead", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "PartitionRead" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.PartitionReadRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.PartitionResponse", + "shortName": "partition_read" }, + "description": "Sample for PartitionRead", "file": "spanner_v1_generated_spanner_partition_read_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_PartitionRead_async", "segments": [ { @@ -1018,18 +1857,50 @@ "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_partition_read_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.partition_read", "method": { + "fullName": "google.spanner.v1.Spanner.PartitionRead", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "PartitionRead" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.PartitionReadRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.PartitionResponse", + "shortName": "partition_read" }, + "description": "Sample for PartitionRead", "file": "spanner_v1_generated_spanner_partition_read_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_PartitionRead_sync", "segments": [ { @@ -1062,19 +1933,51 @@ "start": 43, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_partition_read_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.read", "method": { + "fullName": "google.spanner.v1.Spanner.Read", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "Read" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.ReadRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.ResultSet", + "shortName": "read" }, + "description": "Sample for Read", "file": "spanner_v1_generated_spanner_read_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_Read_async", "segments": [ { @@ -1107,18 +2010,50 @@ "start": 44, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_read_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.read", "method": { + "fullName": "google.spanner.v1.Spanner.Read", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "Read" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.ReadRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.spanner_v1.types.ResultSet", + "shortName": "read" }, + "description": "Sample for Read", "file": "spanner_v1_generated_spanner_read_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_Read_sync", "segments": [ { @@ -1151,19 +2086,58 @@ "start": 44, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_read_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.rollback", "method": { + "fullName": "google.spanner.v1.Spanner.Rollback", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "Rollback" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.RollbackRequest" + }, + { + "name": "session", + "type": "str" + }, + { + "name": "transaction_id", + "type": "bytes" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "rollback" }, + "description": "Sample for Rollback", "file": "spanner_v1_generated_spanner_rollback_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_Rollback_async", "segments": [ { @@ -1194,18 +2168,57 @@ "end": 44, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_rollback_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.rollback", "method": { + "fullName": "google.spanner.v1.Spanner.Rollback", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "Rollback" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.RollbackRequest" + }, + { + "name": "session", + "type": "str" + }, + { + "name": "transaction_id", + "type": "bytes" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "rollback" }, + "description": "Sample for Rollback", "file": "spanner_v1_generated_spanner_rollback_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_Rollback_sync", "segments": [ { @@ -1236,19 +2249,51 @@ "end": 44, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_rollback_sync.py" }, { + "canonical": true, "clientMethod": { "async": true, + "client": { + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient", + "shortName": "SpannerAsyncClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerAsyncClient.streaming_read", "method": { + "fullName": "google.spanner.v1.Spanner.StreamingRead", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "StreamingRead" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.ReadRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "Iterable[google.cloud.spanner_v1.types.PartialResultSet]", + "shortName": "streaming_read" }, + "description": "Sample for StreamingRead", "file": "spanner_v1_generated_spanner_streaming_read_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_StreamingRead_async", "segments": [ { @@ -1281,18 +2326,50 @@ "start": 44, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_streaming_read_async.py" }, { + "canonical": true, "clientMethod": { + "client": { + "fullName": "google.cloud.spanner_v1.SpannerClient", + "shortName": "SpannerClient" + }, + "fullName": "google.cloud.spanner_v1.SpannerClient.streaming_read", "method": { + "fullName": "google.spanner.v1.Spanner.StreamingRead", "service": { + "fullName": "google.spanner.v1.Spanner", "shortName": "Spanner" }, "shortName": "StreamingRead" - } + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.spanner_v1.types.ReadRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "Iterable[google.cloud.spanner_v1.types.PartialResultSet]", + "shortName": "streaming_read" }, + "description": "Sample for StreamingRead", "file": "spanner_v1_generated_spanner_streaming_read_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", "regionTag": "spanner_v1_generated_Spanner_StreamingRead_sync", "segments": [ { @@ -1325,7 +2402,8 @@ "start": 44, "type": "RESPONSE_HANDLING" } - ] + ], + "title": "spanner_v1_generated_spanner_streaming_read_sync.py" } ] } diff --git a/samples/generated_samples/spanner_v1_generated_database_admin_get_iam_policy_async.py b/samples/generated_samples/spanner_v1_generated_database_admin_get_iam_policy_async.py index b9ef3174d4..1959177243 100644 --- a/samples/generated_samples/spanner_v1_generated_database_admin_get_iam_policy_async.py +++ b/samples/generated_samples/spanner_v1_generated_database_admin_get_iam_policy_async.py @@ -25,6 +25,7 @@ # [START spanner_v1_generated_DatabaseAdmin_GetIamPolicy_async] from google.cloud import spanner_admin_database_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore async def sample_get_iam_policy(): @@ -32,7 +33,7 @@ async def sample_get_iam_policy(): client = spanner_admin_database_v1.DatabaseAdminAsyncClient() # Initialize request argument(s) - request = spanner_admin_database_v1.GetIamPolicyRequest( + request = iam_policy_pb2.GetIamPolicyRequest( resource="resource_value", ) diff --git a/samples/generated_samples/spanner_v1_generated_database_admin_get_iam_policy_sync.py b/samples/generated_samples/spanner_v1_generated_database_admin_get_iam_policy_sync.py index 41c61972c6..9be30edfd6 100644 --- a/samples/generated_samples/spanner_v1_generated_database_admin_get_iam_policy_sync.py +++ b/samples/generated_samples/spanner_v1_generated_database_admin_get_iam_policy_sync.py @@ -25,6 +25,7 @@ # [START spanner_v1_generated_DatabaseAdmin_GetIamPolicy_sync] from google.cloud import spanner_admin_database_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_get_iam_policy(): @@ -32,7 +33,7 @@ def sample_get_iam_policy(): client = spanner_admin_database_v1.DatabaseAdminClient() # Initialize request argument(s) - request = spanner_admin_database_v1.GetIamPolicyRequest( + request = iam_policy_pb2.GetIamPolicyRequest( resource="resource_value", ) diff --git a/samples/generated_samples/spanner_v1_generated_database_admin_set_iam_policy_async.py b/samples/generated_samples/spanner_v1_generated_database_admin_set_iam_policy_async.py index 598b532ec5..98c7e11f73 100644 --- a/samples/generated_samples/spanner_v1_generated_database_admin_set_iam_policy_async.py +++ b/samples/generated_samples/spanner_v1_generated_database_admin_set_iam_policy_async.py @@ -25,6 +25,7 @@ # [START spanner_v1_generated_DatabaseAdmin_SetIamPolicy_async] from google.cloud import spanner_admin_database_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore async def sample_set_iam_policy(): @@ -32,7 +33,7 @@ async def sample_set_iam_policy(): client = spanner_admin_database_v1.DatabaseAdminAsyncClient() # Initialize request argument(s) - request = spanner_admin_database_v1.SetIamPolicyRequest( + request = iam_policy_pb2.SetIamPolicyRequest( resource="resource_value", ) diff --git a/samples/generated_samples/spanner_v1_generated_database_admin_set_iam_policy_sync.py b/samples/generated_samples/spanner_v1_generated_database_admin_set_iam_policy_sync.py index 64099fc14d..7afb87925a 100644 --- a/samples/generated_samples/spanner_v1_generated_database_admin_set_iam_policy_sync.py +++ b/samples/generated_samples/spanner_v1_generated_database_admin_set_iam_policy_sync.py @@ -25,6 +25,7 @@ # [START spanner_v1_generated_DatabaseAdmin_SetIamPolicy_sync] from google.cloud import spanner_admin_database_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_set_iam_policy(): @@ -32,7 +33,7 @@ def sample_set_iam_policy(): client = spanner_admin_database_v1.DatabaseAdminClient() # Initialize request argument(s) - request = spanner_admin_database_v1.SetIamPolicyRequest( + request = iam_policy_pb2.SetIamPolicyRequest( resource="resource_value", ) diff --git a/samples/generated_samples/spanner_v1_generated_database_admin_test_iam_permissions_async.py b/samples/generated_samples/spanner_v1_generated_database_admin_test_iam_permissions_async.py index 2c1bcf70c9..9708cba8b0 100644 --- a/samples/generated_samples/spanner_v1_generated_database_admin_test_iam_permissions_async.py +++ b/samples/generated_samples/spanner_v1_generated_database_admin_test_iam_permissions_async.py @@ -25,6 +25,7 @@ # [START spanner_v1_generated_DatabaseAdmin_TestIamPermissions_async] from google.cloud import spanner_admin_database_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore async def sample_test_iam_permissions(): @@ -32,7 +33,7 @@ async def sample_test_iam_permissions(): client = spanner_admin_database_v1.DatabaseAdminAsyncClient() # Initialize request argument(s) - request = spanner_admin_database_v1.TestIamPermissionsRequest( + request = iam_policy_pb2.TestIamPermissionsRequest( resource="resource_value", permissions=['permissions_value_1', 'permissions_value_2'], ) diff --git a/samples/generated_samples/spanner_v1_generated_database_admin_test_iam_permissions_sync.py b/samples/generated_samples/spanner_v1_generated_database_admin_test_iam_permissions_sync.py index 1ebc5140e9..b0aa0f62fb 100644 --- a/samples/generated_samples/spanner_v1_generated_database_admin_test_iam_permissions_sync.py +++ b/samples/generated_samples/spanner_v1_generated_database_admin_test_iam_permissions_sync.py @@ -25,6 +25,7 @@ # [START spanner_v1_generated_DatabaseAdmin_TestIamPermissions_sync] from google.cloud import spanner_admin_database_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_test_iam_permissions(): @@ -32,7 +33,7 @@ def sample_test_iam_permissions(): client = spanner_admin_database_v1.DatabaseAdminClient() # Initialize request argument(s) - request = spanner_admin_database_v1.TestIamPermissionsRequest( + request = iam_policy_pb2.TestIamPermissionsRequest( resource="resource_value", permissions=['permissions_value_1', 'permissions_value_2'], ) diff --git a/samples/generated_samples/spanner_v1_generated_instance_admin_get_iam_policy_async.py b/samples/generated_samples/spanner_v1_generated_instance_admin_get_iam_policy_async.py index 01f1b4e3d2..d052e15b6d 100644 --- a/samples/generated_samples/spanner_v1_generated_instance_admin_get_iam_policy_async.py +++ b/samples/generated_samples/spanner_v1_generated_instance_admin_get_iam_policy_async.py @@ -25,6 +25,7 @@ # [START spanner_v1_generated_InstanceAdmin_GetIamPolicy_async] from google.cloud import spanner_admin_instance_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore async def sample_get_iam_policy(): @@ -32,7 +33,7 @@ async def sample_get_iam_policy(): client = spanner_admin_instance_v1.InstanceAdminAsyncClient() # Initialize request argument(s) - request = spanner_admin_instance_v1.GetIamPolicyRequest( + request = iam_policy_pb2.GetIamPolicyRequest( resource="resource_value", ) diff --git a/samples/generated_samples/spanner_v1_generated_instance_admin_get_iam_policy_sync.py b/samples/generated_samples/spanner_v1_generated_instance_admin_get_iam_policy_sync.py index 8de214c9bb..0c172f5b8d 100644 --- a/samples/generated_samples/spanner_v1_generated_instance_admin_get_iam_policy_sync.py +++ b/samples/generated_samples/spanner_v1_generated_instance_admin_get_iam_policy_sync.py @@ -25,6 +25,7 @@ # [START spanner_v1_generated_InstanceAdmin_GetIamPolicy_sync] from google.cloud import spanner_admin_instance_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_get_iam_policy(): @@ -32,7 +33,7 @@ def sample_get_iam_policy(): client = spanner_admin_instance_v1.InstanceAdminClient() # Initialize request argument(s) - request = spanner_admin_instance_v1.GetIamPolicyRequest( + request = iam_policy_pb2.GetIamPolicyRequest( resource="resource_value", ) diff --git a/samples/generated_samples/spanner_v1_generated_instance_admin_set_iam_policy_async.py b/samples/generated_samples/spanner_v1_generated_instance_admin_set_iam_policy_async.py index ee5d8280ab..25d90383d8 100644 --- a/samples/generated_samples/spanner_v1_generated_instance_admin_set_iam_policy_async.py +++ b/samples/generated_samples/spanner_v1_generated_instance_admin_set_iam_policy_async.py @@ -25,6 +25,7 @@ # [START spanner_v1_generated_InstanceAdmin_SetIamPolicy_async] from google.cloud import spanner_admin_instance_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore async def sample_set_iam_policy(): @@ -32,7 +33,7 @@ async def sample_set_iam_policy(): client = spanner_admin_instance_v1.InstanceAdminAsyncClient() # Initialize request argument(s) - request = spanner_admin_instance_v1.SetIamPolicyRequest( + request = iam_policy_pb2.SetIamPolicyRequest( resource="resource_value", ) diff --git a/samples/generated_samples/spanner_v1_generated_instance_admin_set_iam_policy_sync.py b/samples/generated_samples/spanner_v1_generated_instance_admin_set_iam_policy_sync.py index ea140d4e43..76ae1c544d 100644 --- a/samples/generated_samples/spanner_v1_generated_instance_admin_set_iam_policy_sync.py +++ b/samples/generated_samples/spanner_v1_generated_instance_admin_set_iam_policy_sync.py @@ -25,6 +25,7 @@ # [START spanner_v1_generated_InstanceAdmin_SetIamPolicy_sync] from google.cloud import spanner_admin_instance_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_set_iam_policy(): @@ -32,7 +33,7 @@ def sample_set_iam_policy(): client = spanner_admin_instance_v1.InstanceAdminClient() # Initialize request argument(s) - request = spanner_admin_instance_v1.SetIamPolicyRequest( + request = iam_policy_pb2.SetIamPolicyRequest( resource="resource_value", ) diff --git a/samples/generated_samples/spanner_v1_generated_instance_admin_test_iam_permissions_async.py b/samples/generated_samples/spanner_v1_generated_instance_admin_test_iam_permissions_async.py index 63a65aee57..0669b2b8b6 100644 --- a/samples/generated_samples/spanner_v1_generated_instance_admin_test_iam_permissions_async.py +++ b/samples/generated_samples/spanner_v1_generated_instance_admin_test_iam_permissions_async.py @@ -25,6 +25,7 @@ # [START spanner_v1_generated_InstanceAdmin_TestIamPermissions_async] from google.cloud import spanner_admin_instance_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore async def sample_test_iam_permissions(): @@ -32,7 +33,7 @@ async def sample_test_iam_permissions(): client = spanner_admin_instance_v1.InstanceAdminAsyncClient() # Initialize request argument(s) - request = spanner_admin_instance_v1.TestIamPermissionsRequest( + request = iam_policy_pb2.TestIamPermissionsRequest( resource="resource_value", permissions=['permissions_value_1', 'permissions_value_2'], ) diff --git a/samples/generated_samples/spanner_v1_generated_instance_admin_test_iam_permissions_sync.py b/samples/generated_samples/spanner_v1_generated_instance_admin_test_iam_permissions_sync.py index 55a400649f..a2bad7d92b 100644 --- a/samples/generated_samples/spanner_v1_generated_instance_admin_test_iam_permissions_sync.py +++ b/samples/generated_samples/spanner_v1_generated_instance_admin_test_iam_permissions_sync.py @@ -25,6 +25,7 @@ # [START spanner_v1_generated_InstanceAdmin_TestIamPermissions_sync] from google.cloud import spanner_admin_instance_v1 +from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_test_iam_permissions(): @@ -32,7 +33,7 @@ def sample_test_iam_permissions(): client = spanner_admin_instance_v1.InstanceAdminClient() # Initialize request argument(s) - request = spanner_admin_instance_v1.TestIamPermissionsRequest( + request = iam_policy_pb2.TestIamPermissionsRequest( resource="resource_value", permissions=['permissions_value_1', 'permissions_value_2'], ) diff --git a/scripts/fixup_spanner_admin_database_v1_keywords.py b/scripts/fixup_spanner_admin_database_v1_keywords.py index 5c11670473..af7791c4ad 100644 --- a/scripts/fixup_spanner_admin_database_v1_keywords.py +++ b/scripts/fixup_spanner_admin_database_v1_keywords.py @@ -53,7 +53,7 @@ class spanner_admin_databaseCallTransformer(cst.CSTTransformer): 'list_database_operations': ('parent', 'filter', 'page_size', 'page_token', ), 'list_databases': ('parent', 'page_size', 'page_token', ), 'restore_database': ('parent', 'database_id', 'backup', 'encryption_config', ), - 'set_iam_policy': ('resource', 'policy', ), + 'set_iam_policy': ('resource', 'policy', 'update_mask', ), 'test_iam_permissions': ('resource', 'permissions', ), 'update_backup': ('backup', 'update_mask', ), 'update_database_ddl': ('database', 'statements', 'operation_id', ), diff --git a/scripts/fixup_spanner_admin_instance_v1_keywords.py b/scripts/fixup_spanner_admin_instance_v1_keywords.py index 4142cf7000..7b8b1c9895 100644 --- a/scripts/fixup_spanner_admin_instance_v1_keywords.py +++ b/scripts/fixup_spanner_admin_instance_v1_keywords.py @@ -46,7 +46,7 @@ class spanner_admin_instanceCallTransformer(cst.CSTTransformer): 'get_instance_config': ('name', ), 'list_instance_configs': ('parent', 'page_size', 'page_token', ), 'list_instances': ('parent', 'page_size', 'page_token', 'filter', ), - 'set_iam_policy': ('resource', 'policy', ), + 'set_iam_policy': ('resource', 'policy', 'update_mask', ), 'test_iam_permissions': ('resource', 'permissions', ), 'update_instance': ('instance', 'field_mask', ), } diff --git a/setup.py b/setup.py index 3da9372306..534fa4cb09 100644 --- a/setup.py +++ b/setup.py @@ -37,7 +37,7 @@ # Until this issue is closed # https://github.com/googleapis/google-cloud-python/issues/10566 "google-cloud-core >= 1.4.1, < 3.0dev", - "grpc-google-iam-v1 >= 0.12.3, < 0.13dev", + "grpc-google-iam-v1 >= 0.12.4, <1.0.0dev", "proto-plus >= 1.15.0, != 1.19.6", "sqlparse >= 0.3.0", "packaging >= 14.3", diff --git a/testing/constraints-3.6.txt b/testing/constraints-3.6.txt index 7ceb82cd99..4c581a9373 100644 --- a/testing/constraints-3.6.txt +++ b/testing/constraints-3.6.txt @@ -7,7 +7,7 @@ # Then this file should have foo==1.14.0 google-api-core==1.31.5 google-cloud-core==1.4.1 -grpc-google-iam-v1==0.12.3 +grpc-google-iam-v1==0.12.4 libcst==0.2.5 proto-plus==1.15.0 sqlparse==0.3.0 diff --git a/tests/unit/gapic/spanner_admin_database_v1/test_database_admin.py b/tests/unit/gapic/spanner_admin_database_v1/test_database_admin.py index 4052f1a787..bf1a442f66 100644 --- a/tests/unit/gapic/spanner_admin_database_v1/test_database_admin.py +++ b/tests/unit/gapic/spanner_admin_database_v1/test_database_admin.py @@ -106,24 +106,24 @@ def test__get_default_mtls_endpoint(): @pytest.mark.parametrize( - "client_class", + "client_class,transport_name", [ - DatabaseAdminClient, - DatabaseAdminAsyncClient, + (DatabaseAdminClient, "grpc"), + (DatabaseAdminAsyncClient, "grpc_asyncio"), ], ) -def test_database_admin_client_from_service_account_info(client_class): +def test_database_admin_client_from_service_account_info(client_class, transport_name): creds = ga_credentials.AnonymousCredentials() with mock.patch.object( service_account.Credentials, "from_service_account_info" ) as factory: factory.return_value = creds info = {"valid": True} - client = client_class.from_service_account_info(info) + client = client_class.from_service_account_info(info, transport=transport_name) assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == "spanner.googleapis.com:443" + assert client.transport._host == ("spanner.googleapis.com:443") @pytest.mark.parametrize( @@ -152,27 +152,31 @@ def test_database_admin_client_service_account_always_use_jwt( @pytest.mark.parametrize( - "client_class", + "client_class,transport_name", [ - DatabaseAdminClient, - DatabaseAdminAsyncClient, + (DatabaseAdminClient, "grpc"), + (DatabaseAdminAsyncClient, "grpc_asyncio"), ], ) -def test_database_admin_client_from_service_account_file(client_class): +def test_database_admin_client_from_service_account_file(client_class, transport_name): creds = ga_credentials.AnonymousCredentials() with mock.patch.object( service_account.Credentials, "from_service_account_file" ) as factory: factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json") + client = client_class.from_service_account_file( + "dummy/file/path.json", transport=transport_name + ) assert client.transport._credentials == creds assert isinstance(client, client_class) - client = client_class.from_service_account_json("dummy/file/path.json") + client = client_class.from_service_account_json( + "dummy/file/path.json", transport=transport_name + ) assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == "spanner.googleapis.com:443" + assert client.transport._host == ("spanner.googleapis.com:443") def test_database_admin_client_get_transport_class(): @@ -1032,7 +1036,7 @@ async def test_list_databases_async_pager(): ) assert async_pager.next_page_token == "abc" responses = [] - async for response in async_pager: + async for response in async_pager: # pragma: no branch responses.append(response) assert len(responses) == 6 @@ -1078,7 +1082,9 @@ async def test_list_databases_async_pages(): RuntimeError, ) pages = [] - async for page_ in (await client.list_databases(request={})).pages: + async for page_ in ( + await client.list_databases(request={}) + ).pages: # pragma: no branch pages.append(page_) for page_, token in zip(pages, ["abc", "def", "ghi", ""]): assert page_.raw_page.next_page_token == token @@ -2439,6 +2445,7 @@ def test_set_iam_policy_from_dict_foreign(): request={ "resource": "resource_value", "policy": policy_pb2.Policy(version=774), + "update_mask": field_mask_pb2.FieldMask(paths=["paths_value"]), } ) call.assert_called() @@ -4651,7 +4658,7 @@ async def test_list_backups_async_pager(): ) assert async_pager.next_page_token == "abc" responses = [] - async for response in async_pager: + async for response in async_pager: # pragma: no branch responses.append(response) assert len(responses) == 6 @@ -4697,7 +4704,9 @@ async def test_list_backups_async_pages(): RuntimeError, ) pages = [] - async for page_ in (await client.list_backups(request={})).pages: + async for page_ in ( + await client.list_backups(request={}) + ).pages: # pragma: no branch pages.append(page_) for page_, token in zip(pages, ["abc", "def", "ghi", ""]): assert page_.raw_page.next_page_token == token @@ -5333,7 +5342,7 @@ async def test_list_database_operations_async_pager(): ) assert async_pager.next_page_token == "abc" responses = [] - async for response in async_pager: + async for response in async_pager: # pragma: no branch responses.append(response) assert len(responses) == 6 @@ -5381,7 +5390,9 @@ async def test_list_database_operations_async_pages(): RuntimeError, ) pages = [] - async for page_ in (await client.list_database_operations(request={})).pages: + async for page_ in ( + await client.list_database_operations(request={}) + ).pages: # pragma: no branch pages.append(page_) for page_, token in zip(pages, ["abc", "def", "ghi", ""]): assert page_.raw_page.next_page_token == token @@ -5773,7 +5784,7 @@ async def test_list_backup_operations_async_pager(): ) assert async_pager.next_page_token == "abc" responses = [] - async for response in async_pager: + async for response in async_pager: # pragma: no branch responses.append(response) assert len(responses) == 6 @@ -5821,7 +5832,9 @@ async def test_list_backup_operations_async_pages(): RuntimeError, ) pages = [] - async for page_ in (await client.list_backup_operations(request={})).pages: + async for page_ in ( + await client.list_backup_operations(request={}) + ).pages: # pragma: no branch pages.append(page_) for page_, token in zip(pages, ["abc", "def", "ghi", ""]): assert page_.raw_page.next_page_token == token @@ -5918,6 +5931,19 @@ def test_transport_adc(transport_class): adc.assert_called_once() +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + ], +) +def test_transport_kind(transport_name): + transport = DatabaseAdminClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + + def test_transport_grpc_default(): # A client should use the gRPC transport by default. client = DatabaseAdminClient( @@ -5982,6 +6008,14 @@ def test_database_admin_base_transport(): with pytest.raises(NotImplementedError): transport.operations_client + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + def test_database_admin_base_transport_with_credentials_file(): # Instantiate the base transport with a credentials file @@ -6139,24 +6173,40 @@ def test_database_admin_grpc_transport_client_cert_source_for_mtls(transport_cla ) -def test_database_admin_host_no_port(): +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + ], +) +def test_database_admin_host_no_port(transport_name): client = DatabaseAdminClient( credentials=ga_credentials.AnonymousCredentials(), client_options=client_options.ClientOptions( api_endpoint="spanner.googleapis.com" ), + transport=transport_name, ) - assert client.transport._host == "spanner.googleapis.com:443" + assert client.transport._host == ("spanner.googleapis.com:443") -def test_database_admin_host_with_port(): +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + ], +) +def test_database_admin_host_with_port(transport_name): client = DatabaseAdminClient( credentials=ga_credentials.AnonymousCredentials(), client_options=client_options.ClientOptions( api_endpoint="spanner.googleapis.com:8000" ), + transport=transport_name, ) - assert client.transport._host == "spanner.googleapis.com:8000" + assert client.transport._host == ("spanner.googleapis.com:8000") def test_database_admin_grpc_transport_channel(): diff --git a/tests/unit/gapic/spanner_admin_instance_v1/test_instance_admin.py b/tests/unit/gapic/spanner_admin_instance_v1/test_instance_admin.py index 85309bd8ad..59e7134f41 100644 --- a/tests/unit/gapic/spanner_admin_instance_v1/test_instance_admin.py +++ b/tests/unit/gapic/spanner_admin_instance_v1/test_instance_admin.py @@ -99,24 +99,24 @@ def test__get_default_mtls_endpoint(): @pytest.mark.parametrize( - "client_class", + "client_class,transport_name", [ - InstanceAdminClient, - InstanceAdminAsyncClient, + (InstanceAdminClient, "grpc"), + (InstanceAdminAsyncClient, "grpc_asyncio"), ], ) -def test_instance_admin_client_from_service_account_info(client_class): +def test_instance_admin_client_from_service_account_info(client_class, transport_name): creds = ga_credentials.AnonymousCredentials() with mock.patch.object( service_account.Credentials, "from_service_account_info" ) as factory: factory.return_value = creds info = {"valid": True} - client = client_class.from_service_account_info(info) + client = client_class.from_service_account_info(info, transport=transport_name) assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == "spanner.googleapis.com:443" + assert client.transport._host == ("spanner.googleapis.com:443") @pytest.mark.parametrize( @@ -145,27 +145,31 @@ def test_instance_admin_client_service_account_always_use_jwt( @pytest.mark.parametrize( - "client_class", + "client_class,transport_name", [ - InstanceAdminClient, - InstanceAdminAsyncClient, + (InstanceAdminClient, "grpc"), + (InstanceAdminAsyncClient, "grpc_asyncio"), ], ) -def test_instance_admin_client_from_service_account_file(client_class): +def test_instance_admin_client_from_service_account_file(client_class, transport_name): creds = ga_credentials.AnonymousCredentials() with mock.patch.object( service_account.Credentials, "from_service_account_file" ) as factory: factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json") + client = client_class.from_service_account_file( + "dummy/file/path.json", transport=transport_name + ) assert client.transport._credentials == creds assert isinstance(client, client_class) - client = client_class.from_service_account_json("dummy/file/path.json") + client = client_class.from_service_account_json( + "dummy/file/path.json", transport=transport_name + ) assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == "spanner.googleapis.com:443" + assert client.transport._host == ("spanner.googleapis.com:443") def test_instance_admin_client_get_transport_class(): @@ -1047,7 +1051,7 @@ async def test_list_instance_configs_async_pager(): ) assert async_pager.next_page_token == "abc" responses = [] - async for response in async_pager: + async for response in async_pager: # pragma: no branch responses.append(response) assert len(responses) == 6 @@ -1097,7 +1101,9 @@ async def test_list_instance_configs_async_pages(): RuntimeError, ) pages = [] - async for page_ in (await client.list_instance_configs(request={})).pages: + async for page_ in ( + await client.list_instance_configs(request={}) + ).pages: # pragma: no branch pages.append(page_) for page_, token in zip(pages, ["abc", "def", "ghi", ""]): assert page_.raw_page.next_page_token == token @@ -1725,7 +1731,7 @@ async def test_list_instances_async_pager(): ) assert async_pager.next_page_token == "abc" responses = [] - async for response in async_pager: + async for response in async_pager: # pragma: no branch responses.append(response) assert len(responses) == 6 @@ -1771,7 +1777,9 @@ async def test_list_instances_async_pages(): RuntimeError, ) pages = [] - async for page_ in (await client.list_instances(request={})).pages: + async for page_ in ( + await client.list_instances(request={}) + ).pages: # pragma: no branch pages.append(page_) for page_, token in zip(pages, ["abc", "def", "ghi", ""]): assert page_.raw_page.next_page_token == token @@ -2903,6 +2911,7 @@ def test_set_iam_policy_from_dict_foreign(): request={ "resource": "resource_value", "policy": policy_pb2.Policy(version=774), + "update_mask": field_mask_pb2.FieldMask(paths=["paths_value"]), } ) call.assert_called() @@ -3604,6 +3613,19 @@ def test_transport_adc(transport_class): adc.assert_called_once() +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + ], +) +def test_transport_kind(transport_name): + transport = InstanceAdminClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + + def test_transport_grpc_default(): # A client should use the gRPC transport by default. client = InstanceAdminClient( @@ -3660,6 +3682,14 @@ def test_instance_admin_base_transport(): with pytest.raises(NotImplementedError): transport.operations_client + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + def test_instance_admin_base_transport_with_credentials_file(): # Instantiate the base transport with a credentials file @@ -3817,24 +3847,40 @@ def test_instance_admin_grpc_transport_client_cert_source_for_mtls(transport_cla ) -def test_instance_admin_host_no_port(): +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + ], +) +def test_instance_admin_host_no_port(transport_name): client = InstanceAdminClient( credentials=ga_credentials.AnonymousCredentials(), client_options=client_options.ClientOptions( api_endpoint="spanner.googleapis.com" ), + transport=transport_name, ) - assert client.transport._host == "spanner.googleapis.com:443" + assert client.transport._host == ("spanner.googleapis.com:443") -def test_instance_admin_host_with_port(): +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + ], +) +def test_instance_admin_host_with_port(transport_name): client = InstanceAdminClient( credentials=ga_credentials.AnonymousCredentials(), client_options=client_options.ClientOptions( api_endpoint="spanner.googleapis.com:8000" ), + transport=transport_name, ) - assert client.transport._host == "spanner.googleapis.com:8000" + assert client.transport._host == ("spanner.googleapis.com:8000") def test_instance_admin_grpc_transport_channel(): diff --git a/tests/unit/gapic/spanner_v1/test_spanner.py b/tests/unit/gapic/spanner_v1/test_spanner.py index f0c0f0bafc..d4df289e48 100644 --- a/tests/unit/gapic/spanner_v1/test_spanner.py +++ b/tests/unit/gapic/spanner_v1/test_spanner.py @@ -89,24 +89,24 @@ def test__get_default_mtls_endpoint(): @pytest.mark.parametrize( - "client_class", + "client_class,transport_name", [ - SpannerClient, - SpannerAsyncClient, + (SpannerClient, "grpc"), + (SpannerAsyncClient, "grpc_asyncio"), ], ) -def test_spanner_client_from_service_account_info(client_class): +def test_spanner_client_from_service_account_info(client_class, transport_name): creds = ga_credentials.AnonymousCredentials() with mock.patch.object( service_account.Credentials, "from_service_account_info" ) as factory: factory.return_value = creds info = {"valid": True} - client = client_class.from_service_account_info(info) + client = client_class.from_service_account_info(info, transport=transport_name) assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == "spanner.googleapis.com:443" + assert client.transport._host == ("spanner.googleapis.com:443") @pytest.mark.parametrize( @@ -133,27 +133,31 @@ def test_spanner_client_service_account_always_use_jwt(transport_class, transpor @pytest.mark.parametrize( - "client_class", + "client_class,transport_name", [ - SpannerClient, - SpannerAsyncClient, + (SpannerClient, "grpc"), + (SpannerAsyncClient, "grpc_asyncio"), ], ) -def test_spanner_client_from_service_account_file(client_class): +def test_spanner_client_from_service_account_file(client_class, transport_name): creds = ga_credentials.AnonymousCredentials() with mock.patch.object( service_account.Credentials, "from_service_account_file" ) as factory: factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json") + client = client_class.from_service_account_file( + "dummy/file/path.json", transport=transport_name + ) assert client.transport._credentials == creds assert isinstance(client, client_class) - client = client_class.from_service_account_json("dummy/file/path.json") + client = client_class.from_service_account_json( + "dummy/file/path.json", transport=transport_name + ) assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == "spanner.googleapis.com:443" + assert client.transport._host == ("spanner.googleapis.com:443") def test_spanner_client_get_transport_class(): @@ -1682,7 +1686,7 @@ async def test_list_sessions_async_pager(): ) assert async_pager.next_page_token == "abc" responses = [] - async for response in async_pager: + async for response in async_pager: # pragma: no branch responses.append(response) assert len(responses) == 6 @@ -1728,7 +1732,9 @@ async def test_list_sessions_async_pages(): RuntimeError, ) pages = [] - async for page_ in (await client.list_sessions(request={})).pages: + async for page_ in ( + await client.list_sessions(request={}) + ).pages: # pragma: no branch pages.append(page_) for page_, token in zip(pages, ["abc", "def", "ghi", ""]): assert page_.raw_page.next_page_token == token @@ -3829,6 +3835,19 @@ def test_transport_adc(transport_class): adc.assert_called_once() +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + ], +) +def test_transport_kind(transport_name): + transport = SpannerClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + + def test_transport_grpc_default(): # A client should use the gRPC transport by default. client = SpannerClient( @@ -3885,6 +3904,14 @@ def test_spanner_base_transport(): with pytest.raises(NotImplementedError): transport.close() + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + def test_spanner_base_transport_with_credentials_file(): # Instantiate the base transport with a credentials file @@ -4039,24 +4066,40 @@ def test_spanner_grpc_transport_client_cert_source_for_mtls(transport_class): ) -def test_spanner_host_no_port(): +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + ], +) +def test_spanner_host_no_port(transport_name): client = SpannerClient( credentials=ga_credentials.AnonymousCredentials(), client_options=client_options.ClientOptions( api_endpoint="spanner.googleapis.com" ), + transport=transport_name, ) - assert client.transport._host == "spanner.googleapis.com:443" + assert client.transport._host == ("spanner.googleapis.com:443") -def test_spanner_host_with_port(): +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + ], +) +def test_spanner_host_with_port(transport_name): client = SpannerClient( credentials=ga_credentials.AnonymousCredentials(), client_options=client_options.ClientOptions( api_endpoint="spanner.googleapis.com:8000" ), + transport=transport_name, ) - assert client.transport._host == "spanner.googleapis.com:8000" + assert client.transport._host == ("spanner.googleapis.com:8000") def test_spanner_grpc_transport_channel():