Skip to content

Commit 4e15714

Browse files
gcf-owl-bot[bot]Linchin
gcf-owl-bot[bot]
and
Linchin
authored
feat: add Database.SourceInfo and Database.source_info (information about database provenance, specifically for restored databases) (#963)
* docs: Clarify maximum retention of backups (max 14 weeks) docs: Remove note about backups running at a specific time docs: Standardize on the capitalization of "ID" PiperOrigin-RevId: 668987834 Source-Link: googleapis/googleapis@296afd1 Source-Link: googleapis/googleapis-gen@f4db040 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZjRkYjA0MDA0YzY0ZDUyZjg3YTk5MjZlNzAxODU5NTc3MTNlOGI1YiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add Database.SourceInfo and Database.source_info (information about database provenance, specifically for restored databases) feat: add Database.CmekConfig and Database.cmek_config (information about CMEK enablement) feat: allow specifying an encryption_config when restoring a database feat: add Database.delete_time (the time a database was deleted, if it ever was) feat: add Database.previous_id (if a database was deleted, what ID it was using beforehand) docs: fix assorted capitalization issues with the word "ID" docs: clarify restore details PiperOrigin-RevId: 671737474 Source-Link: googleapis/googleapis@070b0fd Source-Link: googleapis/googleapis-gen@9921c68 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOTkyMWM2ODIzNzkzNDk4YjI5ZTI1M2Y0ZWY0MWQxMjMzNjEyNWU1NCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Lingqing Gan <[email protected]>
1 parent 1614b3f commit 4e15714

File tree

11 files changed

+348
-48
lines changed

11 files changed

+348
-48
lines changed

‎google/cloud/firestore_admin_v1/services/firestore_admin/async_client.py‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,8 @@ class FirestoreAdminAsyncClient:
128128
parse_index_path = staticmethod(FirestoreAdminClient.parse_index_path)
129129
location_path = staticmethod(FirestoreAdminClient.location_path)
130130
parse_location_path = staticmethod(FirestoreAdminClient.parse_location_path)
131+
operation_path = staticmethod(FirestoreAdminClient.operation_path)
132+
parse_operation_path = staticmethod(FirestoreAdminClient.parse_operation_path)
131133
common_billing_account_path = staticmethod(
132134
FirestoreAdminClient.common_billing_account_path
133135
)
@@ -834,7 +836,7 @@ async def sample_get_field():
834836
database.
835837
Fields are grouped by their "Collection
836838
Group", which represent all collections
837-
in the database with the same id.
839+
in the database with the same ID.
838840
839841
"""
840842
# Create or coerce a protobuf request object.
@@ -967,7 +969,7 @@ async def sample_update_field():
967969
968970
Fields are grouped by their "Collection Group", which
969971
represent all collections in the database with the
970-
same id.
972+
same ID.
971973
972974
"""
973975
# Create or coerce a protobuf request object.
@@ -1632,7 +1634,7 @@ async def sample_create_database():
16321634
last a letter or a number. Must not be UUID-like
16331635
/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.
16341636
1635-
"(default)" database id is also valid.
1637+
"(default)" database ID is also valid.
16361638
16371639
This corresponds to the ``database_id`` field
16381640
on the ``request`` instance; if ``request`` is provided, this
@@ -2548,7 +2550,7 @@ async def sample_restore_database():
25482550
Args:
25492551
request (Optional[Union[google.cloud.firestore_admin_v1.types.RestoreDatabaseRequest, dict]]):
25502552
The request object. The request message for
2551-
[FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].
2553+
[FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.FirestoreAdmin.RestoreDatabase].
25522554
retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any,
25532555
should be retried.
25542556
timeout (float): The timeout for this request.

‎google/cloud/firestore_admin_v1/services/firestore_admin/client.py‎

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -378,6 +378,28 @@ def parse_location_path(path: str) -> Dict[str, str]:
378378
m = re.match(r"^projects/(?P<project>.+?)/locations/(?P<location>.+?)$", path)
379379
return m.groupdict() if m else {}
380380

381+
@staticmethod
382+
def operation_path(
383+
project: str,
384+
database: str,
385+
operation: str,
386+
) -> str:
387+
"""Returns a fully-qualified operation string."""
388+
return "projects/{project}/databases/{database}/operations/{operation}".format(
389+
project=project,
390+
database=database,
391+
operation=operation,
392+
)
393+
394+
@staticmethod
395+
def parse_operation_path(path: str) -> Dict[str, str]:
396+
"""Parses a operation path into its component segments."""
397+
m = re.match(
398+
r"^projects/(?P<project>.+?)/databases/(?P<database>.+?)/operations/(?P<operation>.+?)$",
399+
path,
400+
)
401+
return m.groupdict() if m else {}
402+
381403
@staticmethod
382404
def common_billing_account_path(
383405
billing_account: str,
@@ -1354,7 +1376,7 @@ def sample_get_field():
13541376
database.
13551377
Fields are grouped by their "Collection
13561378
Group", which represent all collections
1357-
in the database with the same id.
1379+
in the database with the same ID.
13581380
13591381
"""
13601382
# Create or coerce a protobuf request object.
@@ -1484,7 +1506,7 @@ def sample_update_field():
14841506
14851507
Fields are grouped by their "Collection Group", which
14861508
represent all collections in the database with the
1487-
same id.
1509+
same ID.
14881510
14891511
"""
14901512
# Create or coerce a protobuf request object.
@@ -2134,7 +2156,7 @@ def sample_create_database():
21342156
last a letter or a number. Must not be UUID-like
21352157
/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.
21362158
2137-
"(default)" database id is also valid.
2159+
"(default)" database ID is also valid.
21382160
21392161
This corresponds to the ``database_id`` field
21402162
on the ``request`` instance; if ``request`` is provided, this
@@ -3026,7 +3048,7 @@ def sample_restore_database():
30263048
Args:
30273049
request (Union[google.cloud.firestore_admin_v1.types.RestoreDatabaseRequest, dict]):
30283050
The request object. The request message for
3029-
[FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].
3051+
[FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.FirestoreAdmin.RestoreDatabase].
30303052
retry (google.api_core.retry.Retry): Designation of what errors, if any,
30313053
should be retried.
30323054
timeout (float): The timeout for this request.

‎google/cloud/firestore_admin_v1/services/firestore_admin/transports/rest.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2157,7 +2157,7 @@ def __call__(
21572157
database.
21582158
Fields are grouped by their "Collection
21592159
Group", which represent all collections
2160-
in the database with the same id.
2160+
in the database with the same ID.
21612161
21622162
"""
21632163

@@ -2861,7 +2861,7 @@ def __call__(
28612861
Args:
28622862
request (~.firestore_admin.RestoreDatabaseRequest):
28632863
The request object. The request message for
2864-
[FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].
2864+
[FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.FirestoreAdmin.RestoreDatabase].
28652865
retry (google.api_core.retry.Retry): Designation of what errors, if any,
28662866
should be retried.
28672867
timeout (float): The timeout for this request.

‎google/cloud/firestore_admin_v1/types/database.py‎

Lines changed: 203 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ class Database(proto.Message):
5050
database was most recently updated. Note this
5151
only includes updates to the database resource
5252
and not data contained by the database.
53+
delete_time (google.protobuf.timestamp_pb2.Timestamp):
54+
Output only. The timestamp at which this
55+
database was deleted. Only set if the database
56+
has been deleted.
5357
location_id (str):
5458
The location of the database. Available
5559
locations are listed at
@@ -93,8 +97,8 @@ class Database(proto.Message):
9397
this database.
9498
key_prefix (str):
9599
Output only. The key_prefix for this database. This
96-
key_prefix is used, in combination with the project id ("~")
97-
to construct the application id that is returned from the
100+
key_prefix is used, in combination with the project ID ("~")
101+
to construct the application ID that is returned from the
98102
Cloud Datastore APIs in Google App Engine first generation
99103
runtimes.
100104
@@ -103,6 +107,16 @@ class Database(proto.Message):
103107
v~foo).
104108
delete_protection_state (google.cloud.firestore_admin_v1.types.Database.DeleteProtectionState):
105109
State of delete protection for the database.
110+
cmek_config (google.cloud.firestore_admin_v1.types.Database.CmekConfig):
111+
Optional. Presence indicates CMEK is enabled
112+
for this database.
113+
previous_id (str):
114+
Output only. The database resource's prior
115+
database ID. This field is only populated for
116+
deleted databases.
117+
source_info (google.cloud.firestore_admin_v1.types.Database.SourceInfo):
118+
Output only. Information about the provenance
119+
of this database.
106120
etag (str):
107121
This checksum is computed by the server based
108122
on the value of other fields, and may be sent on
@@ -120,8 +134,7 @@ class DatabaseType(proto.Enum):
120134
121135
Values:
122136
DATABASE_TYPE_UNSPECIFIED (0):
123-
The default value. This value is used if the
124-
database type is omitted.
137+
Not used.
125138
FIRESTORE_NATIVE (1):
126139
Firestore Native Mode
127140
DATASTORE_MODE (2):
@@ -225,6 +238,173 @@ class DeleteProtectionState(proto.Enum):
225238
DELETE_PROTECTION_DISABLED = 1
226239
DELETE_PROTECTION_ENABLED = 2
227240

241+
class CmekConfig(proto.Message):
242+
r"""The CMEK (Customer Managed Encryption Key) configuration for
243+
a Firestore database. If not present, the database is secured by
244+
the default Google encryption key.
245+
246+
Attributes:
247+
kms_key_name (str):
248+
Required. Only keys in the same location as this database
249+
are allowed to be used for encryption.
250+
251+
For Firestore's nam5 multi-region, this corresponds to Cloud
252+
KMS multi-region us. For Firestore's eur3 multi-region, this
253+
corresponds to Cloud KMS multi-region europe. See
254+
https://cloud.google.com/kms/docs/locations.
255+
256+
The expected format is
257+
``projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}``.
258+
active_key_version (MutableSequence[str]):
259+
Output only. Currently in-use `KMS key
260+
versions <https://cloud.google.com/kms/docs/resource-hierarchy#key_versions>`__.
261+
During `key
262+
rotation <https://cloud.google.com/kms/docs/key-rotation>`__,
263+
there can be multiple in-use key versions.
264+
265+
The expected format is
266+
``projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}``.
267+
"""
268+
269+
kms_key_name: str = proto.Field(
270+
proto.STRING,
271+
number=1,
272+
)
273+
active_key_version: MutableSequence[str] = proto.RepeatedField(
274+
proto.STRING,
275+
number=2,
276+
)
277+
278+
class SourceInfo(proto.Message):
279+
r"""Information about the provenance of this database.
280+
281+
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
282+
283+
Attributes:
284+
backup (google.cloud.firestore_admin_v1.types.Database.SourceInfo.BackupSource):
285+
If set, this database was restored from the
286+
specified backup (or a snapshot thereof).
287+
288+
This field is a member of `oneof`_ ``source``.
289+
operation (str):
290+
The associated long-running operation. This field may not be
291+
set after the operation has completed. Format:
292+
``projects/{project}/databases/{database}/operations/{operation}``.
293+
"""
294+
295+
class BackupSource(proto.Message):
296+
r"""Information about a backup that was used to restore a
297+
database.
298+
299+
Attributes:
300+
backup (str):
301+
The resource name of the backup that was used to restore
302+
this database. Format:
303+
``projects/{project}/locations/{location}/backups/{backup}``.
304+
"""
305+
306+
backup: str = proto.Field(
307+
proto.STRING,
308+
number=1,
309+
)
310+
311+
backup: "Database.SourceInfo.BackupSource" = proto.Field(
312+
proto.MESSAGE,
313+
number=1,
314+
oneof="source",
315+
message="Database.SourceInfo.BackupSource",
316+
)
317+
operation: str = proto.Field(
318+
proto.STRING,
319+
number=3,
320+
)
321+
322+
class EncryptionConfig(proto.Message):
323+
r"""Encryption configuration for a new database being created from
324+
another source.
325+
326+
The source could be a [Backup][google.firestore.admin.v1.Backup] .
327+
328+
This message has `oneof`_ fields (mutually exclusive fields).
329+
For each oneof, at most one member field can be set at the same time.
330+
Setting any member of the oneof automatically clears all other
331+
members.
332+
333+
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
334+
335+
Attributes:
336+
google_default_encryption (google.cloud.firestore_admin_v1.types.Database.EncryptionConfig.GoogleDefaultEncryptionOptions):
337+
Use Google default encryption.
338+
339+
This field is a member of `oneof`_ ``encryption_type``.
340+
use_source_encryption (google.cloud.firestore_admin_v1.types.Database.EncryptionConfig.SourceEncryptionOptions):
341+
The database will use the same encryption
342+
configuration as the source.
343+
344+
This field is a member of `oneof`_ ``encryption_type``.
345+
customer_managed_encryption (google.cloud.firestore_admin_v1.types.Database.EncryptionConfig.CustomerManagedEncryptionOptions):
346+
Use Customer Managed Encryption Keys (CMEK)
347+
for encryption.
348+
349+
This field is a member of `oneof`_ ``encryption_type``.
350+
"""
351+
352+
class GoogleDefaultEncryptionOptions(proto.Message):
353+
r"""The configuration options for using Google default
354+
encryption.
355+
356+
"""
357+
358+
class SourceEncryptionOptions(proto.Message):
359+
r"""The configuration options for using the same encryption
360+
method as the source.
361+
362+
"""
363+
364+
class CustomerManagedEncryptionOptions(proto.Message):
365+
r"""The configuration options for using CMEK (Customer Managed
366+
Encryption Key) encryption.
367+
368+
Attributes:
369+
kms_key_name (str):
370+
Required. Only keys in the same location as the database are
371+
allowed to be used for encryption.
372+
373+
For Firestore's nam5 multi-region, this corresponds to Cloud
374+
KMS multi-region us. For Firestore's eur3 multi-region, this
375+
corresponds to Cloud KMS multi-region europe. See
376+
https://cloud.google.com/kms/docs/locations.
377+
378+
The expected format is
379+
``projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}``.
380+
"""
381+
382+
kms_key_name: str = proto.Field(
383+
proto.STRING,
384+
number=1,
385+
)
386+
387+
google_default_encryption: "Database.EncryptionConfig.GoogleDefaultEncryptionOptions" = proto.Field(
388+
proto.MESSAGE,
389+
number=1,
390+
oneof="encryption_type",
391+
message="Database.EncryptionConfig.GoogleDefaultEncryptionOptions",
392+
)
393+
use_source_encryption: "Database.EncryptionConfig.SourceEncryptionOptions" = (
394+
proto.Field(
395+
proto.MESSAGE,
396+
number=2,
397+
oneof="encryption_type",
398+
message="Database.EncryptionConfig.SourceEncryptionOptions",
399+
)
400+
)
401+
customer_managed_encryption: "Database.EncryptionConfig.CustomerManagedEncryptionOptions" = proto.Field(
402+
proto.MESSAGE,
403+
number=3,
404+
oneof="encryption_type",
405+
message="Database.EncryptionConfig.CustomerManagedEncryptionOptions",
406+
)
407+
228408
name: str = proto.Field(
229409
proto.STRING,
230410
number=1,
@@ -243,6 +423,11 @@ class DeleteProtectionState(proto.Enum):
243423
number=6,
244424
message=timestamp_pb2.Timestamp,
245425
)
426+
delete_time: timestamp_pb2.Timestamp = proto.Field(
427+
proto.MESSAGE,
428+
number=7,
429+
message=timestamp_pb2.Timestamp,
430+
)
246431
location_id: str = proto.Field(
247432
proto.STRING,
248433
number=9,
@@ -286,6 +471,20 @@ class DeleteProtectionState(proto.Enum):
286471
number=22,
287472
enum=DeleteProtectionState,
288473
)
474+
cmek_config: CmekConfig = proto.Field(
475+
proto.MESSAGE,
476+
number=23,
477+
message=CmekConfig,
478+
)
479+
previous_id: str = proto.Field(
480+
proto.STRING,
481+
number=25,
482+
)
483+
source_info: SourceInfo = proto.Field(
484+
proto.MESSAGE,
485+
number=26,
486+
message=SourceInfo,
487+
)
289488
etag: str = proto.Field(
290489
proto.STRING,
291490
number=99,

‎google/cloud/firestore_admin_v1/types/field.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ class Field(proto.Message):
3434
r"""Represents a single field in the database.
3535
3636
Fields are grouped by their "Collection Group", which represent
37-
all collections in the database with the same id.
37+
all collections in the database with the same ID.
3838
3939
Attributes:
4040
name (str):

0 commit comments

Comments
 (0)