@@ -273,11 +273,11 @@ def create_database(
273
273
Args:
274
274
parent (str): Required. The name of the instance that will serve the new database.
275
275
Values are of the form ``projects/<project>/instances/<instance>``.
276
- create_statement (str): Required. A ``CREATE DATABASE`` statement, which specifies the ID of the
277
- new database. The database ID must conform to the regular expression
276
+ create_statement (str): Required. A ``CREATE DATABASE`` statement, which specifies the ID of
277
+ the new database. The database ID must conform to the regular expression
278
278
``[a-z][a-z0-9_\-]*[a-z0-9]`` and be between 2 and 30 characters in
279
279
length. If the database ID is a reserved word or if it contains a
280
- hyphen, the database ID must be enclosed in backticks (``` ``).
280
+ hyphen, the database ID must be enclosed in backticks (:literal:`\ ``).
281
281
extra_statements (list[str]): Optional. A list of DDL statements to run inside the newly created
282
282
database. Statements can create tables, indexes, etc. These
283
283
statements execute atomically with the creation of the database:
@@ -451,9 +451,9 @@ def update_database_ddl(
451
451
Args:
452
452
database (str): Required. The database to update.
453
453
statements (list[str]): Required. DDL statements to be applied to the database.
454
- operation_id (str): If empty, the new update request is assigned an automatically-generated
455
- operation ID. Otherwise, ``operation_id`` is used to construct the name
456
- of the resulting ``Operation``.
454
+ operation_id (str): If empty, the new update request is assigned an
455
+ automatically-generated operation ID. Otherwise, ``operation_id`` is
456
+ used to construct the name of the resulting ``Operation``.
457
457
458
458
Specifying an explicit operation ID simplifies determining whether the
459
459
statements were executed in the event that the ``UpdateDatabaseDdl``
@@ -530,8 +530,8 @@ def drop_database(
530
530
metadata = None ,
531
531
):
532
532
"""
533
- Drops (aka deletes) a Cloud Spanner database. Completed backups for the
534
- database will be retained according to their ``expire_time``.
533
+ Drops (aka deletes) a Cloud Spanner database. Completed backups for
534
+ the database will be retained according to their ``expire_time``.
535
535
536
536
Example:
537
537
>>> from google.cloud import spanner_admin_database_v1
@@ -597,9 +597,9 @@ def get_database_ddl(
597
597
metadata = None ,
598
598
):
599
599
"""
600
- Returns the schema of a Cloud Spanner database as a list of formatted
601
- DDL statements. This method does not show pending schema updates, those
602
- may be queried using the ``Operations`` API.
600
+ Returns the schema of a Cloud Spanner database as a list of
601
+ formatted DDL statements. This method does not show pending schema
602
+ updates, those may be queried using the ``Operations`` API.
603
603
604
604
Example:
605
605
>>> from google.cloud import spanner_admin_database_v1
@@ -845,10 +845,10 @@ def test_iam_permissions(
845
845
backup resource.
846
846
847
847
Attempting this RPC on a non-existent Cloud Spanner database will result
848
- in a NOT\_FOUND error if the user has ``spanner.databases.list``
848
+ in a NOT_FOUND error if the user has ``spanner.databases.list``
849
849
permission on the containing Cloud Spanner instance. Otherwise returns
850
850
an empty set of permissions. Calling this method on a backup that does
851
- not exist will result in a NOT\_FOUND error if the user has
851
+ not exist will result in a NOT_FOUND error if the user has
852
852
``spanner.backups.list`` permission on the containing instance.
853
853
854
854
Example:
@@ -867,8 +867,8 @@ def test_iam_permissions(
867
867
Args:
868
868
resource (str): REQUIRED: The resource for which the policy detail is being requested.
869
869
See the operation documentation for the appropriate value for this field.
870
- permissions (list[str]): The set of permissions to check for the ``resource``. Permissions with
871
- wildcards (such as '*' or 'storage.*') are not allowed. For more
870
+ permissions (list[str]): The set of permissions to check for the ``resource``. Permissions
871
+ with wildcards (such as '*' or 'storage.*') are not allowed. For more
872
872
information see `IAM
873
873
Overview <https://cloud.google.com/iam/docs/overview#permissions>`__.
874
874
retry (Optional[google.api_core.retry.Retry]): A retry object used
@@ -966,13 +966,13 @@ def create_backup(
966
966
>>> metadata = response.metadata()
967
967
968
968
Args:
969
- parent (str): Required. The name of the instance in which the backup will be created.
970
- This must be the same instance that contains the database the backup
971
- will be created from. The backup will be stored in the location(s)
972
- specified in the instance configuration of this instance. Values are of
973
- the form ``projects/<project>/instances/<instance>``.
974
- backup_id (str): Required. The id of the backup to be created. The ``backup_id`` appended
975
- to ``parent`` forms the full backup name of the form
969
+ parent (str): Required. The name of the instance in which the backup will be
970
+ created. This must be the same instance that contains the database the
971
+ backup will be created from. The backup will be stored in the
972
+ location(s) specified in the instance configuration of this instance.
973
+ Values are of the form ``projects/<project>/instances/<instance>``.
974
+ backup_id (str): Required. The id of the backup to be created. The ``backup_id``
975
+ appended to ``parent`` forms the full backup name of the form
976
976
``projects/<project>/instances/<instance>/backups/<backup_id>``.
977
977
backup (Union[dict, ~google.cloud.spanner_admin_database_v1.types.Backup]): Required. The backup to create.
978
978
@@ -1129,18 +1129,18 @@ def update_backup(
1129
1129
>>> response = client.update_backup(backup, update_mask)
1130
1130
1131
1131
Args:
1132
- backup (Union[dict, ~google.cloud.spanner_admin_database_v1.types.Backup]): Required. The backup to update. ``backup.name``, and the fields to be
1133
- updated as specified by ``update_mask`` are required. Other fields are
1134
- ignored. Update is only supported for the following fields:
1132
+ backup (Union[dict, ~google.cloud.spanner_admin_database_v1.types.Backup]): Required. The backup to update. ``backup.name``, and the fields to
1133
+ be updated as specified by ``update_mask`` are required. Other fields
1134
+ are ignored. Update is only supported for the following fields:
1135
1135
1136
1136
- ``backup.expire_time``.
1137
1137
1138
1138
If a dict is provided, it must be of the same form as the protobuf
1139
1139
message :class:`~google.cloud.spanner_admin_database_v1.types.Backup`
1140
- update_mask (Union[dict, ~google.cloud.spanner_admin_database_v1.types.FieldMask]): Required. A mask specifying which fields (e.g. ``expire_time``) in the
1141
- Backup resource should be updated. This mask is relative to the Backup
1142
- resource, not to the request message. The field mask must always be
1143
- specified; this prevents any future fields from being erased
1140
+ update_mask (Union[dict, ~google.cloud.spanner_admin_database_v1.types.FieldMask]): Required. A mask specifying which fields (e.g. ``expire_time``) in
1141
+ the Backup resource should be updated. This mask is relative to the
1142
+ Backup resource, not to the request message. The field mask must always
1143
+ be specified; this prevents any future fields from being erased
1144
1144
accidentally by clients that do not know about them.
1145
1145
1146
1146
If a dict is provided, it must be of the same form as the protobuf
@@ -1450,9 +1450,9 @@ def restore_database(
1450
1450
database. This instance must be in the same project and have the same
1451
1451
instance configuration as the instance containing the source backup.
1452
1452
Values are of the form ``projects/<project>/instances/<instance>``.
1453
- database_id (str): Required. The id of the database to create and restore to. This database
1454
- must not already exist. The ``database_id`` appended to ``parent`` forms
1455
- the full database name of the form
1453
+ database_id (str): Required. The id of the database to create and restore to. This
1454
+ database must not already exist. The ``database_id`` appended to
1455
+ ``parent`` forms the full database name of the form
1456
1456
``projects/<project>/instances/<instance>/databases/<database_id>``.
1457
1457
backup (str): Name of the backup from which to restore. Values are of the form
1458
1458
``projects/<project>/instances/<instance>/backups/<backup>``.
@@ -1526,8 +1526,8 @@ def list_database_operations(
1526
1526
metadata = None ,
1527
1527
):
1528
1528
"""
1529
- Lists database ``longrunning-operations``. A database operation has a
1530
- name of the form
1529
+ Lists database ``longrunning-operations``. A database operation has
1530
+ a name of the form
1531
1531
``projects/<project>/instances/<instance>/databases/<database>/operations/<operation>``.
1532
1532
The long-running operation ``metadata`` field type ``metadata.type_url``
1533
1533
describes the type of the metadata. Operations returned include those
@@ -1594,8 +1594,8 @@ def list_database_operations(
1594
1594
1595
1595
- The operation's metadata type is ``RestoreDatabaseMetadata``.
1596
1596
- The database is restored from a backup.
1597
- - The backup name contains "backup\_howl ".
1598
- - The restored database's name contains "restored\_howl ".
1597
+ - The backup name contains "backup_howl ".
1598
+ - The restored database's name contains "restored_howl ".
1599
1599
- The operation started before 2018-03-28T14:50:00Z.
1600
1600
- The operation resulted in an error.
1601
1601
page_size (int): The maximum number of resources contained in the
@@ -1677,8 +1677,8 @@ def list_backup_operations(
1677
1677
metadata = None ,
1678
1678
):
1679
1679
"""
1680
- Lists the backup ``long-running operations`` in the given instance. A
1681
- backup operation has a name of the form
1680
+ Lists the backup ``long-running operations`` in the given instance.
1681
+ A backup operation has a name of the form
1682
1682
``projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>``.
1683
1683
The long-running operation ``metadata`` field type ``metadata.type_url``
1684
1684
describes the type of the metadata. Operations returned include those
@@ -1709,8 +1709,8 @@ def list_backup_operations(
1709
1709
... pass
1710
1710
1711
1711
Args:
1712
- parent (str): Required. The instance of the backup operations. Values are of the form
1713
- ``projects/<project>/instances/<instance>``.
1712
+ parent (str): Required. The instance of the backup operations. Values are of the
1713
+ form ``projects/<project>/instances/<instance>``.
1714
1714
filter_ (str): An expression that filters the list of returned backup operations.
1715
1715
1716
1716
A filter expression consists of a field name, a comparison operator, and
@@ -1851,8 +1851,8 @@ def list_databases(
1851
1851
... pass
1852
1852
1853
1853
Args:
1854
- parent (str): Required. The instance whose databases should be listed. Values are of
1855
- the form ``projects/<project>/instances/<instance>``.
1854
+ parent (str): Required. The instance whose databases should be listed. Values are
1855
+ of the form ``projects/<project>/instances/<instance>``.
1856
1856
page_size (int): The maximum number of resources contained in the
1857
1857
underlying API response. If page streaming is performed per-
1858
1858
resource, this parameter does not affect the return value. If page
0 commit comments