google-apis-firestore_v1 0.97.0 → 0.98.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: e38fb2c8c7e43e9d57eec4549930966b9d579ccd7b9643c835102310b9156d3b
|
|
4
|
+
data.tar.gz: 774baa20de59cd65f2009ea06f62521b21fe5db143edac628e76658baec352f5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8b5c4ec803932ffe9ddbb6a379c002ba31eef47182d2c1695fd6644070fd398b86f767292858ddded18db9311f58e4ed7bcd127448c3e8be102ed9648c42284f
|
|
7
|
+
data.tar.gz: db9f4b2b99ce8f5c293d37dcdea18ef736e0c8f7bafd662f519d911c78a893a1ddd566db8d3284af4c35b366b36623764a3b1d9d800c5687445a2c8261426600
|
data/CHANGELOG.md
CHANGED
|
@@ -1,8 +1,12 @@
|
|
|
1
1
|
# Release history for google-apis-firestore_v1
|
|
2
2
|
|
|
3
|
-
### v0.
|
|
3
|
+
### v0.98.0 (2026-08-23)
|
|
4
4
|
|
|
5
|
-
* Regenerated from discovery document revision
|
|
5
|
+
* Regenerated from discovery document revision 20260810
|
|
6
|
+
|
|
7
|
+
### v0.97.0 (2026-07-19)
|
|
8
|
+
|
|
9
|
+
* Regenerated from discovery document revision 20260706
|
|
6
10
|
|
|
7
11
|
### v0.96.0 (2026-06-21)
|
|
8
12
|
|
|
@@ -910,7 +910,7 @@ module Google
|
|
|
910
910
|
end
|
|
911
911
|
end
|
|
912
912
|
|
|
913
|
-
# The response for Firestore.
|
|
913
|
+
# The response for Firestore.ExecutePipeline.
|
|
914
914
|
class ExecutePipelineResponse
|
|
915
915
|
include Google::Apis::Core::Hashable
|
|
916
916
|
|
|
@@ -1591,6 +1591,77 @@ module Google
|
|
|
1591
1591
|
end
|
|
1592
1592
|
end
|
|
1593
1593
|
|
|
1594
|
+
# A Change Stream is a resource that allows users to receive change
|
|
1595
|
+
# notifications from a Firestore database.
|
|
1596
|
+
class GoogleFirestoreAdminV1ChangeStream
|
|
1597
|
+
include Google::Apis::Core::Hashable
|
|
1598
|
+
|
|
1599
|
+
# The change stream is scoped to a collection group. Only events associated with
|
|
1600
|
+
# the given collection group are visible to the Change Stream. Only a single
|
|
1601
|
+
# change stream can be enabled per collection group.
|
|
1602
|
+
# Corresponds to the JSON property `collectionGroupScope`
|
|
1603
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CollectionGroupScope]
|
|
1604
|
+
attr_accessor :collection_group_scope
|
|
1605
|
+
|
|
1606
|
+
# Output only. The time the Change Stream was created.
|
|
1607
|
+
# Corresponds to the JSON property `createTime`
|
|
1608
|
+
# @return [String]
|
|
1609
|
+
attr_accessor :create_time
|
|
1610
|
+
|
|
1611
|
+
# The change stream is scoped to the entire database. All events in the database
|
|
1612
|
+
# are visible to the Change Stream. One Database scope Change Stream is allowed
|
|
1613
|
+
# per database.
|
|
1614
|
+
# Corresponds to the JSON property `databaseScope`
|
|
1615
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DatabaseScope]
|
|
1616
|
+
attr_accessor :database_scope
|
|
1617
|
+
|
|
1618
|
+
# Optional. An etag used to determine which version of the configuration is
|
|
1619
|
+
# being edited.
|
|
1620
|
+
# Corresponds to the JSON property `etag`
|
|
1621
|
+
# @return [String]
|
|
1622
|
+
attr_accessor :etag
|
|
1623
|
+
|
|
1624
|
+
# Identifier. The external resource name of the change stream. Format `projects/`
|
|
1625
|
+
# project`/databases/`database`/changeStreams/`change_stream``
|
|
1626
|
+
# Corresponds to the JSON property `name`
|
|
1627
|
+
# @return [String]
|
|
1628
|
+
attr_accessor :name
|
|
1629
|
+
|
|
1630
|
+
# Required. The retention period of the change stream. This is the amount of
|
|
1631
|
+
# time a change event is available on the change stream. Must be from 1 to 7
|
|
1632
|
+
# days, inclusive. The retention_period must be in day granularity, i.e. it must
|
|
1633
|
+
# be a multiple of 24 hours.
|
|
1634
|
+
# Corresponds to the JSON property `retentionPeriod`
|
|
1635
|
+
# @return [String]
|
|
1636
|
+
attr_accessor :retention_period
|
|
1637
|
+
|
|
1638
|
+
# Output only. The time the Change Stream started recording events.
|
|
1639
|
+
# Corresponds to the JSON property `startTime`
|
|
1640
|
+
# @return [String]
|
|
1641
|
+
attr_accessor :start_time
|
|
1642
|
+
|
|
1643
|
+
# Output only. The time the Change Stream was last updated.
|
|
1644
|
+
# Corresponds to the JSON property `updateTime`
|
|
1645
|
+
# @return [String]
|
|
1646
|
+
attr_accessor :update_time
|
|
1647
|
+
|
|
1648
|
+
def initialize(**args)
|
|
1649
|
+
update!(**args)
|
|
1650
|
+
end
|
|
1651
|
+
|
|
1652
|
+
# Update properties of this object
|
|
1653
|
+
def update!(**args)
|
|
1654
|
+
@collection_group_scope = args[:collection_group_scope] if args.key?(:collection_group_scope)
|
|
1655
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
|
1656
|
+
@database_scope = args[:database_scope] if args.key?(:database_scope)
|
|
1657
|
+
@etag = args[:etag] if args.key?(:etag)
|
|
1658
|
+
@name = args[:name] if args.key?(:name)
|
|
1659
|
+
@retention_period = args[:retention_period] if args.key?(:retention_period)
|
|
1660
|
+
@start_time = args[:start_time] if args.key?(:start_time)
|
|
1661
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
|
1662
|
+
end
|
|
1663
|
+
end
|
|
1664
|
+
|
|
1594
1665
|
# Metadata for the long-running operation from the CloneDatabase request.
|
|
1595
1666
|
class GoogleFirestoreAdminV1CloneDatabaseMetadata
|
|
1596
1667
|
include Google::Apis::Core::Hashable
|
|
@@ -1731,6 +1802,27 @@ module Google
|
|
|
1731
1802
|
end
|
|
1732
1803
|
end
|
|
1733
1804
|
|
|
1805
|
+
# The change stream is scoped to a collection group. Only events associated with
|
|
1806
|
+
# the given collection group are visible to the Change Stream. Only a single
|
|
1807
|
+
# change stream can be enabled per collection group.
|
|
1808
|
+
class GoogleFirestoreAdminV1CollectionGroupScope
|
|
1809
|
+
include Google::Apis::Core::Hashable
|
|
1810
|
+
|
|
1811
|
+
# Required. The collection group name.
|
|
1812
|
+
# Corresponds to the JSON property `collectionGroupId`
|
|
1813
|
+
# @return [String]
|
|
1814
|
+
attr_accessor :collection_group_id
|
|
1815
|
+
|
|
1816
|
+
def initialize(**args)
|
|
1817
|
+
update!(**args)
|
|
1818
|
+
end
|
|
1819
|
+
|
|
1820
|
+
# Update properties of this object
|
|
1821
|
+
def update!(**args)
|
|
1822
|
+
@collection_group_id = args[:collection_group_id] if args.key?(:collection_group_id)
|
|
1823
|
+
end
|
|
1824
|
+
end
|
|
1825
|
+
|
|
1734
1826
|
# Metadata related to the create database operation.
|
|
1735
1827
|
class GoogleFirestoreAdminV1CreateDatabaseMetadata
|
|
1736
1828
|
include Google::Apis::Core::Hashable
|
|
@@ -1851,7 +1943,7 @@ module Google
|
|
|
1851
1943
|
|
|
1852
1944
|
# Optional. The Firestore API data access mode to use for this database. If not
|
|
1853
1945
|
# set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise
|
|
1854
|
-
#
|
|
1946
|
+
# edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard edition.
|
|
1855
1947
|
# Corresponds to the JSON property `firestoreDataAccessMode`
|
|
1856
1948
|
# @return [String]
|
|
1857
1949
|
attr_accessor :firestore_data_access_mode
|
|
@@ -1886,8 +1978,8 @@ module Google
|
|
|
1886
1978
|
|
|
1887
1979
|
# Optional. The MongoDB compatible API data access mode to use for this database.
|
|
1888
1980
|
# If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for
|
|
1889
|
-
# Enterprise
|
|
1890
|
-
#
|
|
1981
|
+
# Enterprise edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard
|
|
1982
|
+
# edition.
|
|
1891
1983
|
# Corresponds to the JSON property `mongodbCompatibleDataAccessMode`
|
|
1892
1984
|
# @return [String]
|
|
1893
1985
|
attr_accessor :mongodb_compatible_data_access_mode
|
|
@@ -1986,6 +2078,21 @@ module Google
|
|
|
1986
2078
|
end
|
|
1987
2079
|
end
|
|
1988
2080
|
|
|
2081
|
+
# The change stream is scoped to the entire database. All events in the database
|
|
2082
|
+
# are visible to the Change Stream. One Database scope Change Stream is allowed
|
|
2083
|
+
# per database.
|
|
2084
|
+
class GoogleFirestoreAdminV1DatabaseScope
|
|
2085
|
+
include Google::Apis::Core::Hashable
|
|
2086
|
+
|
|
2087
|
+
def initialize(**args)
|
|
2088
|
+
update!(**args)
|
|
2089
|
+
end
|
|
2090
|
+
|
|
2091
|
+
# Update properties of this object
|
|
2092
|
+
def update!(**args)
|
|
2093
|
+
end
|
|
2094
|
+
end
|
|
2095
|
+
|
|
1989
2096
|
# Metadata related to the delete database operation.
|
|
1990
2097
|
class GoogleFirestoreAdminV1DeleteDatabaseMetadata
|
|
1991
2098
|
include Google::Apis::Core::Hashable
|
|
@@ -2457,7 +2564,11 @@ module Google
|
|
|
2457
2564
|
end
|
|
2458
2565
|
|
|
2459
2566
|
# Cloud Firestore indexes enable simple and complex queries against documents in
|
|
2460
|
-
# a database.
|
|
2567
|
+
# a database. In Standard edition databases, single-field indexes are managed
|
|
2568
|
+
# using the google.firestore.admin.v1.Field resource, and composite indexes are
|
|
2569
|
+
# managed using the google.firestore.admin.v1.Index resource. In Enterprise
|
|
2570
|
+
# edition databases, both single-field and composite indexes are managed using
|
|
2571
|
+
# the google.firestore.admin.v1.Index resource.
|
|
2461
2572
|
class GoogleFirestoreAdminV1Index
|
|
2462
2573
|
include Google::Apis::Core::Hashable
|
|
2463
2574
|
|
|
@@ -2471,14 +2582,13 @@ module Google
|
|
|
2471
2582
|
# @return [String]
|
|
2472
2583
|
attr_accessor :density
|
|
2473
2584
|
|
|
2474
|
-
# The fields supported by this index.
|
|
2475
|
-
#
|
|
2476
|
-
# the field path `__name__`. If, on creation, `
|
|
2477
|
-
# the last field, it will be added automatically
|
|
2478
|
-
# of the last field defined. If the final field
|
|
2479
|
-
# directional, the `__name__` will be ordered ASCENDING (
|
|
2480
|
-
# specified).
|
|
2481
|
-
# with a field path equal to the field path of the associated field.
|
|
2585
|
+
# The fields supported by this index. At most 100 fields may be specified. In
|
|
2586
|
+
# Standard edition databases only: - At least 2 fields must be specified. - The
|
|
2587
|
+
# last field entry is always for the field path `__name__`. If, on creation, `
|
|
2588
|
+
# __name__` was not specified as the last field, it will be added automatically
|
|
2589
|
+
# with the same direction as that of the last field defined. If the final field
|
|
2590
|
+
# in the index is not directional, the `__name__` will be ordered ASCENDING (
|
|
2591
|
+
# unless explicitly specified).
|
|
2482
2592
|
# Corresponds to the JSON property `fields`
|
|
2483
2593
|
# @return [Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexField>]
|
|
2484
2594
|
attr_accessor :fields
|
|
@@ -2494,10 +2604,11 @@ module Google
|
|
|
2494
2604
|
attr_accessor :multikey
|
|
2495
2605
|
alias_method :multikey?, :multikey
|
|
2496
2606
|
|
|
2497
|
-
#
|
|
2498
|
-
#
|
|
2499
|
-
# collectionGroups/`collection_id`/indexes/`
|
|
2500
|
-
#
|
|
2607
|
+
# A server-defined name for this index. Output only. When used in the google.
|
|
2608
|
+
# firestore.admin.v1.Index resource, the value is of the form: `projects/`
|
|
2609
|
+
# project_id`/databases/`database_id`/collectionGroups/`collection_id`/indexes/`
|
|
2610
|
+
# index_id`` When used in the google.firestore.admin.v1.Field resource, the
|
|
2611
|
+
# value is empty.
|
|
2501
2612
|
# Corresponds to the JSON property `name`
|
|
2502
2613
|
# @return [String]
|
|
2503
2614
|
attr_accessor :name
|
|
@@ -2610,7 +2721,11 @@ module Google
|
|
|
2610
2721
|
attr_accessor :change_type
|
|
2611
2722
|
|
|
2612
2723
|
# Cloud Firestore indexes enable simple and complex queries against documents in
|
|
2613
|
-
# a database.
|
|
2724
|
+
# a database. In Standard edition databases, single-field indexes are managed
|
|
2725
|
+
# using the google.firestore.admin.v1.Field resource, and composite indexes are
|
|
2726
|
+
# managed using the google.firestore.admin.v1.Index resource. In Enterprise
|
|
2727
|
+
# edition databases, both single-field and composite indexes are managed using
|
|
2728
|
+
# the google.firestore.admin.v1.Index resource.
|
|
2614
2729
|
# Corresponds to the JSON property `index`
|
|
2615
2730
|
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index]
|
|
2616
2731
|
attr_accessor :index
|
|
@@ -2775,6 +2890,25 @@ module Google
|
|
|
2775
2890
|
end
|
|
2776
2891
|
end
|
|
2777
2892
|
|
|
2893
|
+
# Response to FirestoreAdmin.ListChangeStreams.
|
|
2894
|
+
class GoogleFirestoreAdminV1ListChangeStreamsResponse
|
|
2895
|
+
include Google::Apis::Core::Hashable
|
|
2896
|
+
|
|
2897
|
+
# The list of change streams.
|
|
2898
|
+
# Corresponds to the JSON property `changeStreams`
|
|
2899
|
+
# @return [Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream>]
|
|
2900
|
+
attr_accessor :change_streams
|
|
2901
|
+
|
|
2902
|
+
def initialize(**args)
|
|
2903
|
+
update!(**args)
|
|
2904
|
+
end
|
|
2905
|
+
|
|
2906
|
+
# Update properties of this object
|
|
2907
|
+
def update!(**args)
|
|
2908
|
+
@change_streams = args[:change_streams] if args.key?(:change_streams)
|
|
2909
|
+
end
|
|
2910
|
+
end
|
|
2911
|
+
|
|
2778
2912
|
# The list of databases for a project.
|
|
2779
2913
|
class GoogleFirestoreAdminV1ListDatabasesResponse
|
|
2780
2914
|
include Google::Apis::Core::Hashable
|
|
@@ -3347,12 +3481,31 @@ module Google
|
|
|
3347
3481
|
class GoogleFirestoreAdminV1UpdateDatabaseMetadata
|
|
3348
3482
|
include Google::Apis::Core::Hashable
|
|
3349
3483
|
|
|
3484
|
+
# The time this operation completed. Will be unset if operation still in
|
|
3485
|
+
# progress.
|
|
3486
|
+
# Corresponds to the JSON property `endTime`
|
|
3487
|
+
# @return [String]
|
|
3488
|
+
attr_accessor :end_time
|
|
3489
|
+
|
|
3490
|
+
# The time this operation started.
|
|
3491
|
+
# Corresponds to the JSON property `startTime`
|
|
3492
|
+
# @return [String]
|
|
3493
|
+
attr_accessor :start_time
|
|
3494
|
+
|
|
3495
|
+
# The state of the operation.
|
|
3496
|
+
# Corresponds to the JSON property `state`
|
|
3497
|
+
# @return [String]
|
|
3498
|
+
attr_accessor :state
|
|
3499
|
+
|
|
3350
3500
|
def initialize(**args)
|
|
3351
3501
|
update!(**args)
|
|
3352
3502
|
end
|
|
3353
3503
|
|
|
3354
3504
|
# Update properties of this object
|
|
3355
3505
|
def update!(**args)
|
|
3506
|
+
@end_time = args[:end_time] if args.key?(:end_time)
|
|
3507
|
+
@start_time = args[:start_time] if args.key?(:start_time)
|
|
3508
|
+
@state = args[:state] if args.key?(:state)
|
|
3356
3509
|
end
|
|
3357
3510
|
end
|
|
3358
3511
|
|
|
@@ -4878,8 +5031,10 @@ module Google
|
|
|
4878
5031
|
attr_accessor :boolean_value
|
|
4879
5032
|
alias_method :boolean_value?, :boolean_value
|
|
4880
5033
|
|
|
4881
|
-
# A bytes value.
|
|
4882
|
-
# are considered by queries.
|
|
5034
|
+
# A bytes value. In Standard edition databases: * The value must not exceed 1
|
|
5035
|
+
# MiB - 89 bytes. * Only the first 1,500 bytes are considered by queries. In
|
|
5036
|
+
# Enterprise edition databases, there is no limit on the size of the value.
|
|
5037
|
+
# However, it is still subject to document and index entry size limits.
|
|
4883
5038
|
# Corresponds to the JSON property `bytesValue`
|
|
4884
5039
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
|
4885
5040
|
# @return [String]
|
|
@@ -4939,9 +5094,11 @@ module Google
|
|
|
4939
5094
|
# @return [String]
|
|
4940
5095
|
attr_accessor :reference_value
|
|
4941
5096
|
|
|
4942
|
-
# A string value. The string, represented as
|
|
4943
|
-
# bytes. Only the first 1,500 bytes of the
|
|
4944
|
-
# by queries.
|
|
5097
|
+
# A string value. In Standard edition databases: * The string, represented as
|
|
5098
|
+
# UTF-8, must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes of the
|
|
5099
|
+
# UTF-8 representation are considered by queries. In Enterprise edition
|
|
5100
|
+
# databases, there is no limit on the size of the value. However, it is still
|
|
5101
|
+
# subject to document and index entry size limits.
|
|
4945
5102
|
# Corresponds to the JSON property `stringValue`
|
|
4946
5103
|
# @return [String]
|
|
4947
5104
|
attr_accessor :string_value
|
|
@@ -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.98.0"
|
|
20
20
|
|
|
21
21
|
# Version of the code generator used to generate this client
|
|
22
22
|
GENERATOR_VERSION = "0.19.0"
|
|
23
23
|
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
|
25
|
-
REVISION = "
|
|
25
|
+
REVISION = "20260810"
|
|
26
26
|
end
|
|
27
27
|
end
|
|
28
28
|
end
|
|
@@ -286,6 +286,12 @@ module Google
|
|
|
286
286
|
include Google::Apis::Core::JsonObjectSupport
|
|
287
287
|
end
|
|
288
288
|
|
|
289
|
+
class GoogleFirestoreAdminV1ChangeStream
|
|
290
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
291
|
+
|
|
292
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
293
|
+
end
|
|
294
|
+
|
|
289
295
|
class GoogleFirestoreAdminV1CloneDatabaseMetadata
|
|
290
296
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
291
297
|
|
|
@@ -304,6 +310,12 @@ module Google
|
|
|
304
310
|
include Google::Apis::Core::JsonObjectSupport
|
|
305
311
|
end
|
|
306
312
|
|
|
313
|
+
class GoogleFirestoreAdminV1CollectionGroupScope
|
|
314
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
315
|
+
|
|
316
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
317
|
+
end
|
|
318
|
+
|
|
307
319
|
class GoogleFirestoreAdminV1CreateDatabaseMetadata
|
|
308
320
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
309
321
|
|
|
@@ -328,6 +340,12 @@ module Google
|
|
|
328
340
|
include Google::Apis::Core::JsonObjectSupport
|
|
329
341
|
end
|
|
330
342
|
|
|
343
|
+
class GoogleFirestoreAdminV1DatabaseScope
|
|
344
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
345
|
+
|
|
346
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
347
|
+
end
|
|
348
|
+
|
|
331
349
|
class GoogleFirestoreAdminV1DeleteDatabaseMetadata
|
|
332
350
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
333
351
|
|
|
@@ -448,6 +466,12 @@ module Google
|
|
|
448
466
|
include Google::Apis::Core::JsonObjectSupport
|
|
449
467
|
end
|
|
450
468
|
|
|
469
|
+
class GoogleFirestoreAdminV1ListChangeStreamsResponse
|
|
470
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
471
|
+
|
|
472
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
473
|
+
end
|
|
474
|
+
|
|
451
475
|
class GoogleFirestoreAdminV1ListDatabasesResponse
|
|
452
476
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
453
477
|
|
|
@@ -1298,6 +1322,22 @@ module Google
|
|
|
1298
1322
|
end
|
|
1299
1323
|
end
|
|
1300
1324
|
|
|
1325
|
+
class GoogleFirestoreAdminV1ChangeStream
|
|
1326
|
+
# @private
|
|
1327
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1328
|
+
property :collection_group_scope, as: 'collectionGroupScope', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CollectionGroupScope, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CollectionGroupScope::Representation
|
|
1329
|
+
|
|
1330
|
+
property :create_time, as: 'createTime'
|
|
1331
|
+
property :database_scope, as: 'databaseScope', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DatabaseScope, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DatabaseScope::Representation
|
|
1332
|
+
|
|
1333
|
+
property :etag, as: 'etag'
|
|
1334
|
+
property :name, as: 'name'
|
|
1335
|
+
property :retention_period, as: 'retentionPeriod'
|
|
1336
|
+
property :start_time, as: 'startTime'
|
|
1337
|
+
property :update_time, as: 'updateTime'
|
|
1338
|
+
end
|
|
1339
|
+
end
|
|
1340
|
+
|
|
1301
1341
|
class GoogleFirestoreAdminV1CloneDatabaseMetadata
|
|
1302
1342
|
# @private
|
|
1303
1343
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1332,6 +1372,13 @@ module Google
|
|
|
1332
1372
|
end
|
|
1333
1373
|
end
|
|
1334
1374
|
|
|
1375
|
+
class GoogleFirestoreAdminV1CollectionGroupScope
|
|
1376
|
+
# @private
|
|
1377
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1378
|
+
property :collection_group_id, as: 'collectionGroupId'
|
|
1379
|
+
end
|
|
1380
|
+
end
|
|
1381
|
+
|
|
1335
1382
|
class GoogleFirestoreAdminV1CreateDatabaseMetadata
|
|
1336
1383
|
# @private
|
|
1337
1384
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1383,6 +1430,12 @@ module Google
|
|
|
1383
1430
|
end
|
|
1384
1431
|
end
|
|
1385
1432
|
|
|
1433
|
+
class GoogleFirestoreAdminV1DatabaseScope
|
|
1434
|
+
# @private
|
|
1435
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1436
|
+
end
|
|
1437
|
+
end
|
|
1438
|
+
|
|
1386
1439
|
class GoogleFirestoreAdminV1DeleteDatabaseMetadata
|
|
1387
1440
|
# @private
|
|
1388
1441
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1595,6 +1648,14 @@ module Google
|
|
|
1595
1648
|
end
|
|
1596
1649
|
end
|
|
1597
1650
|
|
|
1651
|
+
class GoogleFirestoreAdminV1ListChangeStreamsResponse
|
|
1652
|
+
# @private
|
|
1653
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1654
|
+
collection :change_streams, as: 'changeStreams', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream::Representation
|
|
1655
|
+
|
|
1656
|
+
end
|
|
1657
|
+
end
|
|
1658
|
+
|
|
1598
1659
|
class GoogleFirestoreAdminV1ListDatabasesResponse
|
|
1599
1660
|
# @private
|
|
1600
1661
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1774,6 +1835,9 @@ module Google
|
|
|
1774
1835
|
class GoogleFirestoreAdminV1UpdateDatabaseMetadata
|
|
1775
1836
|
# @private
|
|
1776
1837
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1838
|
+
property :end_time, as: 'endTime'
|
|
1839
|
+
property :start_time, as: 'startTime'
|
|
1840
|
+
property :state, as: 'state'
|
|
1777
1841
|
end
|
|
1778
1842
|
end
|
|
1779
1843
|
|
|
@@ -597,6 +597,144 @@ module Google
|
|
|
597
597
|
execute_or_queue_command(command, &block)
|
|
598
598
|
end
|
|
599
599
|
|
|
600
|
+
# Creates a new change stream for the database.
|
|
601
|
+
# @param [String] parent
|
|
602
|
+
# Required. The parent database to create the change stream for. Format is `
|
|
603
|
+
# projects/`project`/databases/`database``.
|
|
604
|
+
# @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream] google_firestore_admin_v1_change_stream_object
|
|
605
|
+
# @param [String] change_stream_id
|
|
606
|
+
# Required. The ID to use for the change stream, which will become the final
|
|
607
|
+
# component of the change stream's resource name. This value should be 4-63
|
|
608
|
+
# characters. Valid characters are lowercase letters, numbers, and hyphens. The
|
|
609
|
+
# first character must be a letter, and the last character must be a letter or a
|
|
610
|
+
# number.
|
|
611
|
+
# @param [String] fields
|
|
612
|
+
# Selector specifying which fields to include in a partial response.
|
|
613
|
+
# @param [String] quota_user
|
|
614
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
615
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
616
|
+
# @param [Google::Apis::RequestOptions] options
|
|
617
|
+
# Request-specific options
|
|
618
|
+
#
|
|
619
|
+
# @yield [result, err] Result & error if block supplied
|
|
620
|
+
# @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream] parsed result object
|
|
621
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
622
|
+
#
|
|
623
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream]
|
|
624
|
+
#
|
|
625
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
626
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
627
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
628
|
+
def create_project_database_change_stream(parent, google_firestore_admin_v1_change_stream_object = nil, change_stream_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
629
|
+
command = make_simple_command(:post, 'v1/{+parent}/changeStreams', options)
|
|
630
|
+
command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream::Representation
|
|
631
|
+
command.request_object = google_firestore_admin_v1_change_stream_object
|
|
632
|
+
command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream::Representation
|
|
633
|
+
command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream
|
|
634
|
+
command.params['parent'] = parent unless parent.nil?
|
|
635
|
+
command.query['changeStreamId'] = change_stream_id unless change_stream_id.nil?
|
|
636
|
+
command.query['fields'] = fields unless fields.nil?
|
|
637
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
638
|
+
execute_or_queue_command(command, &block)
|
|
639
|
+
end
|
|
640
|
+
|
|
641
|
+
# Deletes a change stream.
|
|
642
|
+
# @param [String] name
|
|
643
|
+
# Required. The name of the change stream to delete. Format is `projects/`
|
|
644
|
+
# project`/databases/`database`/changeStreams/`change_stream``.
|
|
645
|
+
# @param [String] etag
|
|
646
|
+
# Optional. The etag of the change stream to delete. If this is not the current
|
|
647
|
+
# etag of the change stream, the deletion will fail.
|
|
648
|
+
# @param [String] fields
|
|
649
|
+
# Selector specifying which fields to include in a partial response.
|
|
650
|
+
# @param [String] quota_user
|
|
651
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
652
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
653
|
+
# @param [Google::Apis::RequestOptions] options
|
|
654
|
+
# Request-specific options
|
|
655
|
+
#
|
|
656
|
+
# @yield [result, err] Result & error if block supplied
|
|
657
|
+
# @yieldparam result [Google::Apis::FirestoreV1::Empty] parsed result object
|
|
658
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
659
|
+
#
|
|
660
|
+
# @return [Google::Apis::FirestoreV1::Empty]
|
|
661
|
+
#
|
|
662
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
663
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
664
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
665
|
+
def delete_project_database_change_stream(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
666
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
667
|
+
command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
|
|
668
|
+
command.response_class = Google::Apis::FirestoreV1::Empty
|
|
669
|
+
command.params['name'] = name unless name.nil?
|
|
670
|
+
command.query['etag'] = etag unless etag.nil?
|
|
671
|
+
command.query['fields'] = fields unless fields.nil?
|
|
672
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
673
|
+
execute_or_queue_command(command, &block)
|
|
674
|
+
end
|
|
675
|
+
|
|
676
|
+
# Gets information about a change stream.
|
|
677
|
+
# @param [String] name
|
|
678
|
+
# Required. The name of the change stream to retrieve. Format is `projects/`
|
|
679
|
+
# project`/databases/`database`/changeStreams/`change_stream``.
|
|
680
|
+
# @param [String] fields
|
|
681
|
+
# Selector specifying which fields to include in a partial response.
|
|
682
|
+
# @param [String] quota_user
|
|
683
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
684
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
685
|
+
# @param [Google::Apis::RequestOptions] options
|
|
686
|
+
# Request-specific options
|
|
687
|
+
#
|
|
688
|
+
# @yield [result, err] Result & error if block supplied
|
|
689
|
+
# @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream] parsed result object
|
|
690
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
691
|
+
#
|
|
692
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream]
|
|
693
|
+
#
|
|
694
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
695
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
696
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
697
|
+
def get_project_database_change_stream(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
698
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
699
|
+
command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream::Representation
|
|
700
|
+
command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream
|
|
701
|
+
command.params['name'] = name unless name.nil?
|
|
702
|
+
command.query['fields'] = fields unless fields.nil?
|
|
703
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
704
|
+
execute_or_queue_command(command, &block)
|
|
705
|
+
end
|
|
706
|
+
|
|
707
|
+
# Lists all change streams in a database.
|
|
708
|
+
# @param [String] parent
|
|
709
|
+
# Required. The parent database to list change streams from. Format is `projects/
|
|
710
|
+
# `project`/databases/`database``.
|
|
711
|
+
# @param [String] fields
|
|
712
|
+
# Selector specifying which fields to include in a partial response.
|
|
713
|
+
# @param [String] quota_user
|
|
714
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
715
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
716
|
+
# @param [Google::Apis::RequestOptions] options
|
|
717
|
+
# Request-specific options
|
|
718
|
+
#
|
|
719
|
+
# @yield [result, err] Result & error if block supplied
|
|
720
|
+
# @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse] parsed result object
|
|
721
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
722
|
+
#
|
|
723
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse]
|
|
724
|
+
#
|
|
725
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
726
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
727
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
728
|
+
def list_project_database_change_streams(parent, fields: nil, quota_user: nil, options: nil, &block)
|
|
729
|
+
command = make_simple_command(:get, 'v1/{+parent}/changeStreams', options)
|
|
730
|
+
command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse::Representation
|
|
731
|
+
command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse
|
|
732
|
+
command.params['parent'] = parent unless parent.nil?
|
|
733
|
+
command.query['fields'] = fields unless fields.nil?
|
|
734
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
735
|
+
execute_or_queue_command(command, &block)
|
|
736
|
+
end
|
|
737
|
+
|
|
600
738
|
# Gets the metadata and configuration for a Field.
|
|
601
739
|
# @param [String] name
|
|
602
740
|
# Required. A name of the form `projects/`project_id`/databases/`database_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.98.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.98.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:
|