google-apis-firestore_v1 0.77.0 → 0.78.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d1015bd464ddc72d0f2f0d4d5d2c58666d9edd64a33bc5935e8de3406052cf7d
|
4
|
+
data.tar.gz: 19a21c1ada5adf4cda59c5bc8c4fa0471b09cee6c323505b24cf62d3d44cf941
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2c84c49f3d07ab9b8e1fc34c507cff56d0670d44250b453dcb7bd7e0010e03b1b74afba7c95ac29ef1cbbd8bc08a57da8c728e95093e412b57b44f28e36ae259
|
7
|
+
data.tar.gz: 262bff697534f176cd1c462e80665adf06fcfdbdcc91873782216fcdb4b16072dee28b1f682736bc06c8551b67a50fc545705e159ae8056795f5f809d7c6f4de
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,10 @@
|
|
1
1
|
# Release history for google-apis-firestore_v1
|
2
2
|
|
3
|
+
### v0.78.0 (2025-06-29)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20250618
|
6
|
+
* Regenerated using generator version 0.18.0
|
7
|
+
|
3
8
|
### v0.77.0 (2025-05-11)
|
4
9
|
|
5
10
|
* Regenerated using generator version 0.17.0
|
@@ -1395,6 +1395,109 @@ module Google
|
|
1395
1395
|
end
|
1396
1396
|
end
|
1397
1397
|
|
1398
|
+
# Metadata for the long-running operation from the CloneDatabase request.
|
1399
|
+
class GoogleFirestoreAdminV1CloneDatabaseMetadata
|
1400
|
+
include Google::Apis::Core::Hashable
|
1401
|
+
|
1402
|
+
# The name of the database being cloned to.
|
1403
|
+
# Corresponds to the JSON property `database`
|
1404
|
+
# @return [String]
|
1405
|
+
attr_accessor :database
|
1406
|
+
|
1407
|
+
# The time the clone finished, unset for ongoing clones.
|
1408
|
+
# Corresponds to the JSON property `endTime`
|
1409
|
+
# @return [String]
|
1410
|
+
attr_accessor :end_time
|
1411
|
+
|
1412
|
+
# The operation state of the clone.
|
1413
|
+
# Corresponds to the JSON property `operationState`
|
1414
|
+
# @return [String]
|
1415
|
+
attr_accessor :operation_state
|
1416
|
+
|
1417
|
+
# A consistent snapshot of a database at a specific point in time. A PITR (Point-
|
1418
|
+
# in-time recovery) snapshot with previous versions of a database's data is
|
1419
|
+
# available for every minute up to the associated database's data retention
|
1420
|
+
# period. If the PITR feature is enabled, the retention period is 7 days;
|
1421
|
+
# otherwise, it is one hour.
|
1422
|
+
# Corresponds to the JSON property `pitrSnapshot`
|
1423
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1PitrSnapshot]
|
1424
|
+
attr_accessor :pitr_snapshot
|
1425
|
+
|
1426
|
+
# Describes the progress of the operation. Unit of work is generic and must be
|
1427
|
+
# interpreted based on where Progress is used.
|
1428
|
+
# Corresponds to the JSON property `progressPercentage`
|
1429
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress]
|
1430
|
+
attr_accessor :progress_percentage
|
1431
|
+
|
1432
|
+
# The time the clone was started.
|
1433
|
+
# Corresponds to the JSON property `startTime`
|
1434
|
+
# @return [String]
|
1435
|
+
attr_accessor :start_time
|
1436
|
+
|
1437
|
+
def initialize(**args)
|
1438
|
+
update!(**args)
|
1439
|
+
end
|
1440
|
+
|
1441
|
+
# Update properties of this object
|
1442
|
+
def update!(**args)
|
1443
|
+
@database = args[:database] if args.key?(:database)
|
1444
|
+
@end_time = args[:end_time] if args.key?(:end_time)
|
1445
|
+
@operation_state = args[:operation_state] if args.key?(:operation_state)
|
1446
|
+
@pitr_snapshot = args[:pitr_snapshot] if args.key?(:pitr_snapshot)
|
1447
|
+
@progress_percentage = args[:progress_percentage] if args.key?(:progress_percentage)
|
1448
|
+
@start_time = args[:start_time] if args.key?(:start_time)
|
1449
|
+
end
|
1450
|
+
end
|
1451
|
+
|
1452
|
+
# The request message for FirestoreAdmin.CloneDatabase.
|
1453
|
+
class GoogleFirestoreAdminV1CloneDatabaseRequest
|
1454
|
+
include Google::Apis::Core::Hashable
|
1455
|
+
|
1456
|
+
# Required. The ID to use for the database, which will become the final
|
1457
|
+
# component of the database's resource name. This database ID must not be
|
1458
|
+
# associated with an existing database. This value should be 4-63 characters.
|
1459
|
+
# Valid characters are /a-z-/ with first character a letter and the last a
|
1460
|
+
# letter or a number. Must not be UUID-like /[0-9a-f]`8`(-[0-9a-f]`4`)`3`-[0-9a-
|
1461
|
+
# f]`12`/. "(default)" database ID is also valid.
|
1462
|
+
# Corresponds to the JSON property `databaseId`
|
1463
|
+
# @return [String]
|
1464
|
+
attr_accessor :database_id
|
1465
|
+
|
1466
|
+
# Encryption configuration for a new database being created from another source.
|
1467
|
+
# The source could be a Backup .
|
1468
|
+
# Corresponds to the JSON property `encryptionConfig`
|
1469
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EncryptionConfig]
|
1470
|
+
attr_accessor :encryption_config
|
1471
|
+
|
1472
|
+
# A consistent snapshot of a database at a specific point in time. A PITR (Point-
|
1473
|
+
# in-time recovery) snapshot with previous versions of a database's data is
|
1474
|
+
# available for every minute up to the associated database's data retention
|
1475
|
+
# period. If the PITR feature is enabled, the retention period is 7 days;
|
1476
|
+
# otherwise, it is one hour.
|
1477
|
+
# Corresponds to the JSON property `pitrSnapshot`
|
1478
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1PitrSnapshot]
|
1479
|
+
attr_accessor :pitr_snapshot
|
1480
|
+
|
1481
|
+
# Optional. Immutable. Tags to be bound to the cloned database. The tags should
|
1482
|
+
# be provided in the format of `tagKeys/`tag_key_id` -> tagValues/`tag_value_id``
|
1483
|
+
# .
|
1484
|
+
# Corresponds to the JSON property `tags`
|
1485
|
+
# @return [Hash<String,String>]
|
1486
|
+
attr_accessor :tags
|
1487
|
+
|
1488
|
+
def initialize(**args)
|
1489
|
+
update!(**args)
|
1490
|
+
end
|
1491
|
+
|
1492
|
+
# Update properties of this object
|
1493
|
+
def update!(**args)
|
1494
|
+
@database_id = args[:database_id] if args.key?(:database_id)
|
1495
|
+
@encryption_config = args[:encryption_config] if args.key?(:encryption_config)
|
1496
|
+
@pitr_snapshot = args[:pitr_snapshot] if args.key?(:pitr_snapshot)
|
1497
|
+
@tags = args[:tags] if args.key?(:tags)
|
1498
|
+
end
|
1499
|
+
end
|
1500
|
+
|
1398
1501
|
# The CMEK (Customer Managed Encryption Key) configuration for a Firestore
|
1399
1502
|
# database. If not present, the database is secured by the default Google
|
1400
1503
|
# encryption key.
|
@@ -2537,6 +2640,43 @@ module Google
|
|
2537
2640
|
end
|
2538
2641
|
end
|
2539
2642
|
|
2643
|
+
# A consistent snapshot of a database at a specific point in time. A PITR (Point-
|
2644
|
+
# in-time recovery) snapshot with previous versions of a database's data is
|
2645
|
+
# available for every minute up to the associated database's data retention
|
2646
|
+
# period. If the PITR feature is enabled, the retention period is 7 days;
|
2647
|
+
# otherwise, it is one hour.
|
2648
|
+
class GoogleFirestoreAdminV1PitrSnapshot
|
2649
|
+
include Google::Apis::Core::Hashable
|
2650
|
+
|
2651
|
+
# Required. The name of the database that this was a snapshot of. Format: `
|
2652
|
+
# projects/`project`/databases/`database``.
|
2653
|
+
# Corresponds to the JSON property `database`
|
2654
|
+
# @return [String]
|
2655
|
+
attr_accessor :database
|
2656
|
+
|
2657
|
+
# Output only. Public UUID of the database the snapshot was associated with.
|
2658
|
+
# Corresponds to the JSON property `databaseUid`
|
2659
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
2660
|
+
# @return [String]
|
2661
|
+
attr_accessor :database_uid
|
2662
|
+
|
2663
|
+
# Required. Snapshot time of the database.
|
2664
|
+
# Corresponds to the JSON property `snapshotTime`
|
2665
|
+
# @return [String]
|
2666
|
+
attr_accessor :snapshot_time
|
2667
|
+
|
2668
|
+
def initialize(**args)
|
2669
|
+
update!(**args)
|
2670
|
+
end
|
2671
|
+
|
2672
|
+
# Update properties of this object
|
2673
|
+
def update!(**args)
|
2674
|
+
@database = args[:database] if args.key?(:database)
|
2675
|
+
@database_uid = args[:database_uid] if args.key?(:database_uid)
|
2676
|
+
@snapshot_time = args[:snapshot_time] if args.key?(:snapshot_time)
|
2677
|
+
end
|
2678
|
+
end
|
2679
|
+
|
2540
2680
|
# Describes the progress of the operation. Unit of work is generic and must be
|
2541
2681
|
# interpreted based on where Progress is used.
|
2542
2682
|
class GoogleFirestoreAdminV1Progress
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module FirestoreV1
|
18
18
|
# Version of the google-apis-firestore_v1 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.78.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
|
-
GENERATOR_VERSION = "0.
|
22
|
+
GENERATOR_VERSION = "0.18.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20250618"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -262,6 +262,18 @@ module Google
|
|
262
262
|
include Google::Apis::Core::JsonObjectSupport
|
263
263
|
end
|
264
264
|
|
265
|
+
class GoogleFirestoreAdminV1CloneDatabaseMetadata
|
266
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
267
|
+
|
268
|
+
include Google::Apis::Core::JsonObjectSupport
|
269
|
+
end
|
270
|
+
|
271
|
+
class GoogleFirestoreAdminV1CloneDatabaseRequest
|
272
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
273
|
+
|
274
|
+
include Google::Apis::Core::JsonObjectSupport
|
275
|
+
end
|
276
|
+
|
265
277
|
class GoogleFirestoreAdminV1CmekConfig
|
266
278
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
267
279
|
|
@@ -442,6 +454,12 @@ module Google
|
|
442
454
|
include Google::Apis::Core::JsonObjectSupport
|
443
455
|
end
|
444
456
|
|
457
|
+
class GoogleFirestoreAdminV1PitrSnapshot
|
458
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
459
|
+
|
460
|
+
include Google::Apis::Core::JsonObjectSupport
|
461
|
+
end
|
462
|
+
|
445
463
|
class GoogleFirestoreAdminV1Progress
|
446
464
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
447
465
|
|
@@ -1149,6 +1167,32 @@ module Google
|
|
1149
1167
|
end
|
1150
1168
|
end
|
1151
1169
|
|
1170
|
+
class GoogleFirestoreAdminV1CloneDatabaseMetadata
|
1171
|
+
# @private
|
1172
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1173
|
+
property :database, as: 'database'
|
1174
|
+
property :end_time, as: 'endTime'
|
1175
|
+
property :operation_state, as: 'operationState'
|
1176
|
+
property :pitr_snapshot, as: 'pitrSnapshot', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1PitrSnapshot, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1PitrSnapshot::Representation
|
1177
|
+
|
1178
|
+
property :progress_percentage, as: 'progressPercentage', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress::Representation
|
1179
|
+
|
1180
|
+
property :start_time, as: 'startTime'
|
1181
|
+
end
|
1182
|
+
end
|
1183
|
+
|
1184
|
+
class GoogleFirestoreAdminV1CloneDatabaseRequest
|
1185
|
+
# @private
|
1186
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1187
|
+
property :database_id, as: 'databaseId'
|
1188
|
+
property :encryption_config, as: 'encryptionConfig', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EncryptionConfig, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EncryptionConfig::Representation
|
1189
|
+
|
1190
|
+
property :pitr_snapshot, as: 'pitrSnapshot', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1PitrSnapshot, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1PitrSnapshot::Representation
|
1191
|
+
|
1192
|
+
hash :tags, as: 'tags'
|
1193
|
+
end
|
1194
|
+
end
|
1195
|
+
|
1152
1196
|
class GoogleFirestoreAdminV1CmekConfig
|
1153
1197
|
# @private
|
1154
1198
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1453,6 +1497,15 @@ module Google
|
|
1453
1497
|
end
|
1454
1498
|
end
|
1455
1499
|
|
1500
|
+
class GoogleFirestoreAdminV1PitrSnapshot
|
1501
|
+
# @private
|
1502
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1503
|
+
property :database, as: 'database'
|
1504
|
+
property :database_uid, :base64 => true, as: 'databaseUid'
|
1505
|
+
property :snapshot_time, as: 'snapshotTime'
|
1506
|
+
end
|
1507
|
+
end
|
1508
|
+
|
1456
1509
|
class GoogleFirestoreAdminV1Progress
|
1457
1510
|
# @private
|
1458
1511
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -91,6 +91,48 @@ module Google
|
|
91
91
|
execute_or_queue_command(command, &block)
|
92
92
|
end
|
93
93
|
|
94
|
+
# Creates a new database by cloning an existing one. The new database must be in
|
95
|
+
# the same cloud region or multi-region location as the existing database. This
|
96
|
+
# behaves similar to FirestoreAdmin.CreateDatabase except instead of creating a
|
97
|
+
# new empty database, a new database is created with the database type, index
|
98
|
+
# configuration, and documents from an existing database. The long-running
|
99
|
+
# operation can be used to track the progress of the clone, with the Operation's
|
100
|
+
# metadata field type being the CloneDatabaseMetadata. The response type is the
|
101
|
+
# Database if the clone was successful. The new database is not readable or
|
102
|
+
# writeable until the LRO has completed.
|
103
|
+
# @param [String] parent
|
104
|
+
# Required. The project to clone the database in. Format is `projects/`
|
105
|
+
# project_id``.
|
106
|
+
# @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CloneDatabaseRequest] google_firestore_admin_v1_clone_database_request_object
|
107
|
+
# @param [String] fields
|
108
|
+
# Selector specifying which fields to include in a partial response.
|
109
|
+
# @param [String] quota_user
|
110
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
111
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
112
|
+
# @param [Google::Apis::RequestOptions] options
|
113
|
+
# Request-specific options
|
114
|
+
#
|
115
|
+
# @yield [result, err] Result & error if block supplied
|
116
|
+
# @yieldparam result [Google::Apis::FirestoreV1::GoogleLongrunningOperation] parsed result object
|
117
|
+
# @yieldparam err [StandardError] error object if request failed
|
118
|
+
#
|
119
|
+
# @return [Google::Apis::FirestoreV1::GoogleLongrunningOperation]
|
120
|
+
#
|
121
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
122
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
123
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
124
|
+
def clone_project_database(parent, google_firestore_admin_v1_clone_database_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
125
|
+
command = make_simple_command(:post, 'v1/{+parent}/databases:clone', options)
|
126
|
+
command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CloneDatabaseRequest::Representation
|
127
|
+
command.request_object = google_firestore_admin_v1_clone_database_request_object
|
128
|
+
command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
|
129
|
+
command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
|
130
|
+
command.params['parent'] = parent unless parent.nil?
|
131
|
+
command.query['fields'] = fields unless fields.nil?
|
132
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
133
|
+
execute_or_queue_command(command, &block)
|
134
|
+
end
|
135
|
+
|
94
136
|
# Create a database.
|
95
137
|
# @param [String] parent
|
96
138
|
# Required. A parent name of the form `projects/`project_id``
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-firestore_v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.78.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
@@ -57,7 +57,7 @@ licenses:
|
|
57
57
|
metadata:
|
58
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
59
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1/CHANGELOG.md
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.78.0
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
|
62
62
|
rdoc_options: []
|
63
63
|
require_paths:
|
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
73
73
|
- !ruby/object:Gem::Version
|
74
74
|
version: '0'
|
75
75
|
requirements: []
|
76
|
-
rubygems_version: 3.6.
|
76
|
+
rubygems_version: 3.6.9
|
77
77
|
specification_version: 4
|
78
78
|
summary: Simple REST client for Cloud Firestore API V1
|
79
79
|
test_files: []
|