google-apis-firestore_v1 0.39.0 → 0.40.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: 9f49b7196e442f0a00b5054282e2ca801c4ce4b05b34a999356ec436838a6127
|
4
|
+
data.tar.gz: 4ff8ff144116f5e49a2e47ef0eb1d76d7753c5a443423561403116a61b833d83
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cc5fa26b3a63854c82f4818bb7306fb20341699080b73d81d3a96957f41619343188b8270aaef0e543711274ef55522313230113615b4db6eed19aa614313c9b
|
7
|
+
data.tar.gz: 42745540b791410f625f8116b44fe37ec72700ee0864a447a66c5664cadf31c177a360d68b7db60a6f0956c61c94258ead42cdda7956c820acf3ed699e4632d8
|
data/CHANGELOG.md
CHANGED
@@ -284,6 +284,88 @@ module Google
|
|
284
284
|
end
|
285
285
|
end
|
286
286
|
|
287
|
+
# A sequence of bits, encoded in a byte array. Each byte in the `bitmap` byte
|
288
|
+
# array stores 8 bits of the sequence. The only exception is the last byte,
|
289
|
+
# which may store 8 _or fewer_ bits. The `padding` defines the number of bits of
|
290
|
+
# the last byte to be ignored as "padding". The values of these "padding" bits
|
291
|
+
# are unspecified and must be ignored. To retrieve the first bit, bit 0,
|
292
|
+
# calculate: `(bitmap[0] & 0x01) != 0`. To retrieve the second bit, bit 1,
|
293
|
+
# calculate: `(bitmap[0] & 0x02) != 0`. To retrieve the third bit, bit 2,
|
294
|
+
# calculate: `(bitmap[0] & 0x04) != 0`. To retrieve the fourth bit, bit 3,
|
295
|
+
# calculate: `(bitmap[0] & 0x08) != 0`. To retrieve bit n, calculate: `(bitmap[n
|
296
|
+
# / 8] & (0x01 << (n % 8))) != 0`. The "size" of a `BitSequence` (the number of
|
297
|
+
# bits it contains) is calculated by this formula: `(bitmap.length * 8) -
|
298
|
+
# padding`.
|
299
|
+
class BitSequence
|
300
|
+
include Google::Apis::Core::Hashable
|
301
|
+
|
302
|
+
# The bytes that encode the bit sequence. May have a length of zero.
|
303
|
+
# Corresponds to the JSON property `bitmap`
|
304
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
305
|
+
# @return [String]
|
306
|
+
attr_accessor :bitmap
|
307
|
+
|
308
|
+
# The number of bits of the last byte in `bitmap` to ignore as "padding". If the
|
309
|
+
# length of `bitmap` is zero, then this value must be `0`. Otherwise, this value
|
310
|
+
# must be between 0 and 7, inclusive.
|
311
|
+
# Corresponds to the JSON property `padding`
|
312
|
+
# @return [Fixnum]
|
313
|
+
attr_accessor :padding
|
314
|
+
|
315
|
+
def initialize(**args)
|
316
|
+
update!(**args)
|
317
|
+
end
|
318
|
+
|
319
|
+
# Update properties of this object
|
320
|
+
def update!(**args)
|
321
|
+
@bitmap = args[:bitmap] if args.key?(:bitmap)
|
322
|
+
@padding = args[:padding] if args.key?(:padding)
|
323
|
+
end
|
324
|
+
end
|
325
|
+
|
326
|
+
# A bloom filter (https://en.wikipedia.org/wiki/Bloom_filter). The bloom filter
|
327
|
+
# hashes the entries with MD5 and treats the resulting 128-bit hash as 2
|
328
|
+
# distinct 64-bit hash values, interpreted as unsigned integers using 2's
|
329
|
+
# complement encoding. These two hash values, named `h1` and `h2`, are then used
|
330
|
+
# to compute the `hash_count` hash values using the formula, starting at `i=0`:
|
331
|
+
# h(i) = h1 + (i * h2) These resulting values are then taken modulo the number
|
332
|
+
# of bits in the bloom filter to get the bits of the bloom filter to test for
|
333
|
+
# the given entry.
|
334
|
+
class BloomFilter
|
335
|
+
include Google::Apis::Core::Hashable
|
336
|
+
|
337
|
+
# A sequence of bits, encoded in a byte array. Each byte in the `bitmap` byte
|
338
|
+
# array stores 8 bits of the sequence. The only exception is the last byte,
|
339
|
+
# which may store 8 _or fewer_ bits. The `padding` defines the number of bits of
|
340
|
+
# the last byte to be ignored as "padding". The values of these "padding" bits
|
341
|
+
# are unspecified and must be ignored. To retrieve the first bit, bit 0,
|
342
|
+
# calculate: `(bitmap[0] & 0x01) != 0`. To retrieve the second bit, bit 1,
|
343
|
+
# calculate: `(bitmap[0] & 0x02) != 0`. To retrieve the third bit, bit 2,
|
344
|
+
# calculate: `(bitmap[0] & 0x04) != 0`. To retrieve the fourth bit, bit 3,
|
345
|
+
# calculate: `(bitmap[0] & 0x08) != 0`. To retrieve bit n, calculate: `(bitmap[n
|
346
|
+
# / 8] & (0x01 << (n % 8))) != 0`. The "size" of a `BitSequence` (the number of
|
347
|
+
# bits it contains) is calculated by this formula: `(bitmap.length * 8) -
|
348
|
+
# padding`.
|
349
|
+
# Corresponds to the JSON property `bits`
|
350
|
+
# @return [Google::Apis::FirestoreV1::BitSequence]
|
351
|
+
attr_accessor :bits
|
352
|
+
|
353
|
+
# The number of hashes used by the algorithm.
|
354
|
+
# Corresponds to the JSON property `hashCount`
|
355
|
+
# @return [Fixnum]
|
356
|
+
attr_accessor :hash_count
|
357
|
+
|
358
|
+
def initialize(**args)
|
359
|
+
update!(**args)
|
360
|
+
end
|
361
|
+
|
362
|
+
# Update properties of this object
|
363
|
+
def update!(**args)
|
364
|
+
@bits = args[:bits] if args.key?(:bits)
|
365
|
+
@hash_count = args[:hash_count] if args.key?(:hash_count)
|
366
|
+
end
|
367
|
+
end
|
368
|
+
|
287
369
|
# A selection of a collection, such as `messages as m1`.
|
288
370
|
class CollectionSelector
|
289
371
|
include Google::Apis::Core::Hashable
|
@@ -707,6 +789,18 @@ module Google
|
|
707
789
|
# @return [Fixnum]
|
708
790
|
attr_accessor :target_id
|
709
791
|
|
792
|
+
# A bloom filter (https://en.wikipedia.org/wiki/Bloom_filter). The bloom filter
|
793
|
+
# hashes the entries with MD5 and treats the resulting 128-bit hash as 2
|
794
|
+
# distinct 64-bit hash values, interpreted as unsigned integers using 2's
|
795
|
+
# complement encoding. These two hash values, named `h1` and `h2`, are then used
|
796
|
+
# to compute the `hash_count` hash values using the formula, starting at `i=0`:
|
797
|
+
# h(i) = h1 + (i * h2) These resulting values are then taken modulo the number
|
798
|
+
# of bits in the bloom filter to get the bits of the bloom filter to test for
|
799
|
+
# the given entry.
|
800
|
+
# Corresponds to the JSON property `unchangedNames`
|
801
|
+
# @return [Google::Apis::FirestoreV1::BloomFilter]
|
802
|
+
attr_accessor :unchanged_names
|
803
|
+
|
710
804
|
def initialize(**args)
|
711
805
|
update!(**args)
|
712
806
|
end
|
@@ -715,6 +809,7 @@ module Google
|
|
715
809
|
def update!(**args)
|
716
810
|
@count = args[:count] if args.key?(:count)
|
717
811
|
@target_id = args[:target_id] if args.key?(:target_id)
|
812
|
+
@unchanged_names = args[:unchanged_names] if args.key?(:unchanged_names)
|
718
813
|
end
|
719
814
|
end
|
720
815
|
|
@@ -855,6 +950,139 @@ module Google
|
|
855
950
|
end
|
856
951
|
end
|
857
952
|
|
953
|
+
# A Backup of a Cloud Firestore Database. The backup contains all documents and
|
954
|
+
# index configurations for the given database at specific point in time.
|
955
|
+
class GoogleFirestoreAdminV1Backup
|
956
|
+
include Google::Apis::Core::Hashable
|
957
|
+
|
958
|
+
# Output only. Name of the Firestore database that the backup is from. Format is
|
959
|
+
# `projects/`project`/databases/`database``.
|
960
|
+
# Corresponds to the JSON property `database`
|
961
|
+
# @return [String]
|
962
|
+
attr_accessor :database
|
963
|
+
|
964
|
+
# Output only. The system-generated UUID4 for the Firestore database that the
|
965
|
+
# backup is from.
|
966
|
+
# Corresponds to the JSON property `databaseUid`
|
967
|
+
# @return [String]
|
968
|
+
attr_accessor :database_uid
|
969
|
+
|
970
|
+
# Output only. The timestamp at which this backup expires.
|
971
|
+
# Corresponds to the JSON property `expireTime`
|
972
|
+
# @return [String]
|
973
|
+
attr_accessor :expire_time
|
974
|
+
|
975
|
+
# Output only. The unique resource name of the Backup. Format is `projects/`
|
976
|
+
# project`/locations/`location`/backups/`backup``.
|
977
|
+
# Corresponds to the JSON property `name`
|
978
|
+
# @return [String]
|
979
|
+
attr_accessor :name
|
980
|
+
|
981
|
+
# Output only. The backup contains an externally consistent copy of the database
|
982
|
+
# at this time.
|
983
|
+
# Corresponds to the JSON property `snapshotTime`
|
984
|
+
# @return [String]
|
985
|
+
attr_accessor :snapshot_time
|
986
|
+
|
987
|
+
# Output only. The current state of the backup.
|
988
|
+
# Corresponds to the JSON property `state`
|
989
|
+
# @return [String]
|
990
|
+
attr_accessor :state
|
991
|
+
|
992
|
+
# Backup specific statistics.
|
993
|
+
# Corresponds to the JSON property `stats`
|
994
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Stats]
|
995
|
+
attr_accessor :stats
|
996
|
+
|
997
|
+
def initialize(**args)
|
998
|
+
update!(**args)
|
999
|
+
end
|
1000
|
+
|
1001
|
+
# Update properties of this object
|
1002
|
+
def update!(**args)
|
1003
|
+
@database = args[:database] if args.key?(:database)
|
1004
|
+
@database_uid = args[:database_uid] if args.key?(:database_uid)
|
1005
|
+
@expire_time = args[:expire_time] if args.key?(:expire_time)
|
1006
|
+
@name = args[:name] if args.key?(:name)
|
1007
|
+
@snapshot_time = args[:snapshot_time] if args.key?(:snapshot_time)
|
1008
|
+
@state = args[:state] if args.key?(:state)
|
1009
|
+
@stats = args[:stats] if args.key?(:stats)
|
1010
|
+
end
|
1011
|
+
end
|
1012
|
+
|
1013
|
+
# A backup schedule for a Cloud Firestore Database. This resource is owned by
|
1014
|
+
# the database it is backing up, and is deleted along with the database. The
|
1015
|
+
# actual backups are not though.
|
1016
|
+
class GoogleFirestoreAdminV1BackupSchedule
|
1017
|
+
include Google::Apis::Core::Hashable
|
1018
|
+
|
1019
|
+
# Output only. The timestamp at which this backup schedule was created and
|
1020
|
+
# effective since. No backups will be created for this schedule before this time.
|
1021
|
+
# Corresponds to the JSON property `createTime`
|
1022
|
+
# @return [String]
|
1023
|
+
attr_accessor :create_time
|
1024
|
+
|
1025
|
+
# Represent a recurring schedule that runs at a specific time every day. The
|
1026
|
+
# time zone is UTC.
|
1027
|
+
# Corresponds to the JSON property `dailyRecurrence`
|
1028
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DailyRecurrence]
|
1029
|
+
attr_accessor :daily_recurrence
|
1030
|
+
|
1031
|
+
# Output only. The unique backup schedule identifier across all locations and
|
1032
|
+
# databases for the given project. This will be auto-assigned. Format is `
|
1033
|
+
# projects/`project`/databases/`database`/backupSchedules/`backup_schedule``
|
1034
|
+
# Corresponds to the JSON property `name`
|
1035
|
+
# @return [String]
|
1036
|
+
attr_accessor :name
|
1037
|
+
|
1038
|
+
# At what relative time in the future, compared to the creation time of the
|
1039
|
+
# backup should the backup be deleted, i.e. keep backups for 7 days.
|
1040
|
+
# Corresponds to the JSON property `retention`
|
1041
|
+
# @return [String]
|
1042
|
+
attr_accessor :retention
|
1043
|
+
|
1044
|
+
# Output only. The timestamp at which this backup schedule was most recently
|
1045
|
+
# updated. When a backup schedule is first created, this is the same as
|
1046
|
+
# create_time.
|
1047
|
+
# Corresponds to the JSON property `updateTime`
|
1048
|
+
# @return [String]
|
1049
|
+
attr_accessor :update_time
|
1050
|
+
|
1051
|
+
# Represents a recurring schedule that runs on a specified day of the week. The
|
1052
|
+
# time zone is UTC.
|
1053
|
+
# Corresponds to the JSON property `weeklyRecurrence`
|
1054
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1WeeklyRecurrence]
|
1055
|
+
attr_accessor :weekly_recurrence
|
1056
|
+
|
1057
|
+
def initialize(**args)
|
1058
|
+
update!(**args)
|
1059
|
+
end
|
1060
|
+
|
1061
|
+
# Update properties of this object
|
1062
|
+
def update!(**args)
|
1063
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1064
|
+
@daily_recurrence = args[:daily_recurrence] if args.key?(:daily_recurrence)
|
1065
|
+
@name = args[:name] if args.key?(:name)
|
1066
|
+
@retention = args[:retention] if args.key?(:retention)
|
1067
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1068
|
+
@weekly_recurrence = args[:weekly_recurrence] if args.key?(:weekly_recurrence)
|
1069
|
+
end
|
1070
|
+
end
|
1071
|
+
|
1072
|
+
# Represent a recurring schedule that runs at a specific time every day. The
|
1073
|
+
# time zone is UTC.
|
1074
|
+
class GoogleFirestoreAdminV1DailyRecurrence
|
1075
|
+
include Google::Apis::Core::Hashable
|
1076
|
+
|
1077
|
+
def initialize(**args)
|
1078
|
+
update!(**args)
|
1079
|
+
end
|
1080
|
+
|
1081
|
+
# Update properties of this object
|
1082
|
+
def update!(**args)
|
1083
|
+
end
|
1084
|
+
end
|
1085
|
+
|
858
1086
|
# A Cloud Firestore Database. Currently only one database is allowed per cloud
|
859
1087
|
# project; this database must have a `database_id` of '(default)'.
|
860
1088
|
class GoogleFirestoreAdminV1Database
|
@@ -1519,6 +1747,55 @@ module Google
|
|
1519
1747
|
end
|
1520
1748
|
end
|
1521
1749
|
|
1750
|
+
# The response for FirestoreAdmin.ListBackupSchedules.
|
1751
|
+
class GoogleFirestoreAdminV1ListBackupSchedulesResponse
|
1752
|
+
include Google::Apis::Core::Hashable
|
1753
|
+
|
1754
|
+
# List of all backup schedules.
|
1755
|
+
# Corresponds to the JSON property `backupSchedules`
|
1756
|
+
# @return [Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule>]
|
1757
|
+
attr_accessor :backup_schedules
|
1758
|
+
|
1759
|
+
def initialize(**args)
|
1760
|
+
update!(**args)
|
1761
|
+
end
|
1762
|
+
|
1763
|
+
# Update properties of this object
|
1764
|
+
def update!(**args)
|
1765
|
+
@backup_schedules = args[:backup_schedules] if args.key?(:backup_schedules)
|
1766
|
+
end
|
1767
|
+
end
|
1768
|
+
|
1769
|
+
# The response for FirestoreAdmin.ListBackups.
|
1770
|
+
class GoogleFirestoreAdminV1ListBackupsResponse
|
1771
|
+
include Google::Apis::Core::Hashable
|
1772
|
+
|
1773
|
+
# List of all backups for the project. Ordered by `location ASC, create_time
|
1774
|
+
# DESC, name ASC`.
|
1775
|
+
# Corresponds to the JSON property `backups`
|
1776
|
+
# @return [Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup>]
|
1777
|
+
attr_accessor :backups
|
1778
|
+
|
1779
|
+
# List of locations that existing backups were not able to be fetched from.
|
1780
|
+
# Instead of failing the entire requests when a single location is unreachable,
|
1781
|
+
# this response returns a partial result set and list of locations unable to be
|
1782
|
+
# reached here. The request can be retried against a single location to get a
|
1783
|
+
# concrete error.
|
1784
|
+
# Corresponds to the JSON property `unreachable`
|
1785
|
+
# @return [Array<String>]
|
1786
|
+
attr_accessor :unreachable
|
1787
|
+
|
1788
|
+
def initialize(**args)
|
1789
|
+
update!(**args)
|
1790
|
+
end
|
1791
|
+
|
1792
|
+
# Update properties of this object
|
1793
|
+
def update!(**args)
|
1794
|
+
@backups = args[:backups] if args.key?(:backups)
|
1795
|
+
@unreachable = args[:unreachable] if args.key?(:unreachable)
|
1796
|
+
end
|
1797
|
+
end
|
1798
|
+
|
1522
1799
|
# The list of databases for a project.
|
1523
1800
|
class GoogleFirestoreAdminV1ListDatabasesResponse
|
1524
1801
|
include Google::Apis::Core::Hashable
|
@@ -1629,6 +1906,69 @@ module Google
|
|
1629
1906
|
end
|
1630
1907
|
end
|
1631
1908
|
|
1909
|
+
# The request message for FirestoreAdmin.RestoreDatabase.
|
1910
|
+
class GoogleFirestoreAdminV1RestoreDatabaseRequest
|
1911
|
+
include Google::Apis::Core::Hashable
|
1912
|
+
|
1913
|
+
# Required. Backup to restore from. Must be from the same project as the parent.
|
1914
|
+
# Format is: `projects/`project_id`/locations/`location`/backups/`backup``
|
1915
|
+
# Corresponds to the JSON property `backup`
|
1916
|
+
# @return [String]
|
1917
|
+
attr_accessor :backup
|
1918
|
+
|
1919
|
+
# Required. The ID to use for the database, which will become the final
|
1920
|
+
# component of the database's resource name. This database id must not be
|
1921
|
+
# associated with an existing database. This value should be 4-63 characters.
|
1922
|
+
# Valid characters are /a-z-/ with first character a letter and the last a
|
1923
|
+
# letter or a number. Must not be UUID-like /[0-9a-f]`8`(-[0-9a-f]`4`)`3`-[0-9a-
|
1924
|
+
# f]`12`/. "(default)" database id is also valid.
|
1925
|
+
# Corresponds to the JSON property `databaseId`
|
1926
|
+
# @return [String]
|
1927
|
+
attr_accessor :database_id
|
1928
|
+
|
1929
|
+
def initialize(**args)
|
1930
|
+
update!(**args)
|
1931
|
+
end
|
1932
|
+
|
1933
|
+
# Update properties of this object
|
1934
|
+
def update!(**args)
|
1935
|
+
@backup = args[:backup] if args.key?(:backup)
|
1936
|
+
@database_id = args[:database_id] if args.key?(:database_id)
|
1937
|
+
end
|
1938
|
+
end
|
1939
|
+
|
1940
|
+
# Backup specific statistics.
|
1941
|
+
class GoogleFirestoreAdminV1Stats
|
1942
|
+
include Google::Apis::Core::Hashable
|
1943
|
+
|
1944
|
+
# Output only. The total number of documents contained in the backup.
|
1945
|
+
# Corresponds to the JSON property `documentCount`
|
1946
|
+
# @return [Fixnum]
|
1947
|
+
attr_accessor :document_count
|
1948
|
+
|
1949
|
+
# Output only. The total number of index entries contained in the backup.
|
1950
|
+
# Corresponds to the JSON property `indexCount`
|
1951
|
+
# @return [Fixnum]
|
1952
|
+
attr_accessor :index_count
|
1953
|
+
|
1954
|
+
# Output only. Summation of the size of all documents and index entries in the
|
1955
|
+
# backup, measured in bytes.
|
1956
|
+
# Corresponds to the JSON property `sizeBytes`
|
1957
|
+
# @return [Fixnum]
|
1958
|
+
attr_accessor :size_bytes
|
1959
|
+
|
1960
|
+
def initialize(**args)
|
1961
|
+
update!(**args)
|
1962
|
+
end
|
1963
|
+
|
1964
|
+
# Update properties of this object
|
1965
|
+
def update!(**args)
|
1966
|
+
@document_count = args[:document_count] if args.key?(:document_count)
|
1967
|
+
@index_count = args[:index_count] if args.key?(:index_count)
|
1968
|
+
@size_bytes = args[:size_bytes] if args.key?(:size_bytes)
|
1969
|
+
end
|
1970
|
+
end
|
1971
|
+
|
1632
1972
|
# The TTL (time-to-live) configuration for documents that have this `Field` set.
|
1633
1973
|
# Storing a timestamp value into a TTL-enabled field will be treated as the
|
1634
1974
|
# document's absolute expiration time. Timestamp values in the past indicate
|
@@ -1685,6 +2025,26 @@ module Google
|
|
1685
2025
|
end
|
1686
2026
|
end
|
1687
2027
|
|
2028
|
+
# Represents a recurring schedule that runs on a specified day of the week. The
|
2029
|
+
# time zone is UTC.
|
2030
|
+
class GoogleFirestoreAdminV1WeeklyRecurrence
|
2031
|
+
include Google::Apis::Core::Hashable
|
2032
|
+
|
2033
|
+
# The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
|
2034
|
+
# Corresponds to the JSON property `day`
|
2035
|
+
# @return [String]
|
2036
|
+
attr_accessor :day
|
2037
|
+
|
2038
|
+
def initialize(**args)
|
2039
|
+
update!(**args)
|
2040
|
+
end
|
2041
|
+
|
2042
|
+
# Update properties of this object
|
2043
|
+
def update!(**args)
|
2044
|
+
@day = args[:day] if args.key?(:day)
|
2045
|
+
end
|
2046
|
+
end
|
2047
|
+
|
1688
2048
|
# The request message for Operations.CancelOperation.
|
1689
2049
|
class GoogleLongrunningCancelOperationRequest
|
1690
2050
|
include Google::Apis::Core::Hashable
|
@@ -2655,6 +3015,14 @@ module Google
|
|
2655
3015
|
# @return [Google::Apis::FirestoreV1::DocumentsTarget]
|
2656
3016
|
attr_accessor :documents
|
2657
3017
|
|
3018
|
+
# The number of documents that last matched the query at the resume token or
|
3019
|
+
# read time. This value is only relevant when a `resume_type` is provided. This
|
3020
|
+
# value being present and greater than zero signals that the client wants `
|
3021
|
+
# ExistenceFilter.unchanged_names` to be included in the response.
|
3022
|
+
# Corresponds to the JSON property `expectedCount`
|
3023
|
+
# @return [Fixnum]
|
3024
|
+
attr_accessor :expected_count
|
3025
|
+
|
2658
3026
|
# If the target should be removed once it is current and consistent.
|
2659
3027
|
# Corresponds to the JSON property `once`
|
2660
3028
|
# @return [Boolean]
|
@@ -2692,6 +3060,7 @@ module Google
|
|
2692
3060
|
# Update properties of this object
|
2693
3061
|
def update!(**args)
|
2694
3062
|
@documents = args[:documents] if args.key?(:documents)
|
3063
|
+
@expected_count = args[:expected_count] if args.key?(:expected_count)
|
2695
3064
|
@once = args[:once] if args.key?(:once)
|
2696
3065
|
@query = args[:query] if args.key?(:query)
|
2697
3066
|
@read_time = args[:read_time] if args.key?(:read_time)
|
@@ -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.40.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.12.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20230508"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -76,6 +76,18 @@ module Google
|
|
76
76
|
include Google::Apis::Core::JsonObjectSupport
|
77
77
|
end
|
78
78
|
|
79
|
+
class BitSequence
|
80
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
81
|
+
|
82
|
+
include Google::Apis::Core::JsonObjectSupport
|
83
|
+
end
|
84
|
+
|
85
|
+
class BloomFilter
|
86
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
87
|
+
|
88
|
+
include Google::Apis::Core::JsonObjectSupport
|
89
|
+
end
|
90
|
+
|
79
91
|
class CollectionSelector
|
80
92
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
81
93
|
|
@@ -190,6 +202,24 @@ module Google
|
|
190
202
|
include Google::Apis::Core::JsonObjectSupport
|
191
203
|
end
|
192
204
|
|
205
|
+
class GoogleFirestoreAdminV1Backup
|
206
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
207
|
+
|
208
|
+
include Google::Apis::Core::JsonObjectSupport
|
209
|
+
end
|
210
|
+
|
211
|
+
class GoogleFirestoreAdminV1BackupSchedule
|
212
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
213
|
+
|
214
|
+
include Google::Apis::Core::JsonObjectSupport
|
215
|
+
end
|
216
|
+
|
217
|
+
class GoogleFirestoreAdminV1DailyRecurrence
|
218
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
219
|
+
|
220
|
+
include Google::Apis::Core::JsonObjectSupport
|
221
|
+
end
|
222
|
+
|
193
223
|
class GoogleFirestoreAdminV1Database
|
194
224
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
195
225
|
|
@@ -268,6 +298,18 @@ module Google
|
|
268
298
|
include Google::Apis::Core::JsonObjectSupport
|
269
299
|
end
|
270
300
|
|
301
|
+
class GoogleFirestoreAdminV1ListBackupSchedulesResponse
|
302
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
303
|
+
|
304
|
+
include Google::Apis::Core::JsonObjectSupport
|
305
|
+
end
|
306
|
+
|
307
|
+
class GoogleFirestoreAdminV1ListBackupsResponse
|
308
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
309
|
+
|
310
|
+
include Google::Apis::Core::JsonObjectSupport
|
311
|
+
end
|
312
|
+
|
271
313
|
class GoogleFirestoreAdminV1ListDatabasesResponse
|
272
314
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
273
315
|
|
@@ -298,6 +340,18 @@ module Google
|
|
298
340
|
include Google::Apis::Core::JsonObjectSupport
|
299
341
|
end
|
300
342
|
|
343
|
+
class GoogleFirestoreAdminV1RestoreDatabaseRequest
|
344
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
345
|
+
|
346
|
+
include Google::Apis::Core::JsonObjectSupport
|
347
|
+
end
|
348
|
+
|
349
|
+
class GoogleFirestoreAdminV1Stats
|
350
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
351
|
+
|
352
|
+
include Google::Apis::Core::JsonObjectSupport
|
353
|
+
end
|
354
|
+
|
301
355
|
class GoogleFirestoreAdminV1TtlConfig
|
302
356
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
303
357
|
|
@@ -316,6 +370,12 @@ module Google
|
|
316
370
|
include Google::Apis::Core::JsonObjectSupport
|
317
371
|
end
|
318
372
|
|
373
|
+
class GoogleFirestoreAdminV1WeeklyRecurrence
|
374
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
375
|
+
|
376
|
+
include Google::Apis::Core::JsonObjectSupport
|
377
|
+
end
|
378
|
+
|
319
379
|
class GoogleLongrunningCancelOperationRequest
|
320
380
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
321
381
|
|
@@ -621,6 +681,23 @@ module Google
|
|
621
681
|
end
|
622
682
|
end
|
623
683
|
|
684
|
+
class BitSequence
|
685
|
+
# @private
|
686
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
687
|
+
property :bitmap, :base64 => true, as: 'bitmap'
|
688
|
+
property :padding, as: 'padding'
|
689
|
+
end
|
690
|
+
end
|
691
|
+
|
692
|
+
class BloomFilter
|
693
|
+
# @private
|
694
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
695
|
+
property :bits, as: 'bits', class: Google::Apis::FirestoreV1::BitSequence, decorator: Google::Apis::FirestoreV1::BitSequence::Representation
|
696
|
+
|
697
|
+
property :hash_count, as: 'hashCount'
|
698
|
+
end
|
699
|
+
end
|
700
|
+
|
624
701
|
class CollectionSelector
|
625
702
|
# @private
|
626
703
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -745,6 +822,8 @@ module Google
|
|
745
822
|
class Representation < Google::Apis::Core::JsonRepresentation
|
746
823
|
property :count, as: 'count'
|
747
824
|
property :target_id, as: 'targetId'
|
825
|
+
property :unchanged_names, as: 'unchangedNames', class: Google::Apis::FirestoreV1::BloomFilter, decorator: Google::Apis::FirestoreV1::BloomFilter::Representation
|
826
|
+
|
748
827
|
end
|
749
828
|
end
|
750
829
|
|
@@ -796,6 +875,40 @@ module Google
|
|
796
875
|
end
|
797
876
|
end
|
798
877
|
|
878
|
+
class GoogleFirestoreAdminV1Backup
|
879
|
+
# @private
|
880
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
881
|
+
property :database, as: 'database'
|
882
|
+
property :database_uid, as: 'databaseUid'
|
883
|
+
property :expire_time, as: 'expireTime'
|
884
|
+
property :name, as: 'name'
|
885
|
+
property :snapshot_time, as: 'snapshotTime'
|
886
|
+
property :state, as: 'state'
|
887
|
+
property :stats, as: 'stats', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Stats, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Stats::Representation
|
888
|
+
|
889
|
+
end
|
890
|
+
end
|
891
|
+
|
892
|
+
class GoogleFirestoreAdminV1BackupSchedule
|
893
|
+
# @private
|
894
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
895
|
+
property :create_time, as: 'createTime'
|
896
|
+
property :daily_recurrence, as: 'dailyRecurrence', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DailyRecurrence, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DailyRecurrence::Representation
|
897
|
+
|
898
|
+
property :name, as: 'name'
|
899
|
+
property :retention, as: 'retention'
|
900
|
+
property :update_time, as: 'updateTime'
|
901
|
+
property :weekly_recurrence, as: 'weeklyRecurrence', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1WeeklyRecurrence, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1WeeklyRecurrence::Representation
|
902
|
+
|
903
|
+
end
|
904
|
+
end
|
905
|
+
|
906
|
+
class GoogleFirestoreAdminV1DailyRecurrence
|
907
|
+
# @private
|
908
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
909
|
+
end
|
910
|
+
end
|
911
|
+
|
799
912
|
class GoogleFirestoreAdminV1Database
|
800
913
|
# @private
|
801
914
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -954,6 +1067,23 @@ module Google
|
|
954
1067
|
end
|
955
1068
|
end
|
956
1069
|
|
1070
|
+
class GoogleFirestoreAdminV1ListBackupSchedulesResponse
|
1071
|
+
# @private
|
1072
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1073
|
+
collection :backup_schedules, as: 'backupSchedules', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule::Representation
|
1074
|
+
|
1075
|
+
end
|
1076
|
+
end
|
1077
|
+
|
1078
|
+
class GoogleFirestoreAdminV1ListBackupsResponse
|
1079
|
+
# @private
|
1080
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1081
|
+
collection :backups, as: 'backups', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup::Representation
|
1082
|
+
|
1083
|
+
collection :unreachable, as: 'unreachable'
|
1084
|
+
end
|
1085
|
+
end
|
1086
|
+
|
957
1087
|
class GoogleFirestoreAdminV1ListDatabasesResponse
|
958
1088
|
# @private
|
959
1089
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -994,6 +1124,23 @@ module Google
|
|
994
1124
|
end
|
995
1125
|
end
|
996
1126
|
|
1127
|
+
class GoogleFirestoreAdminV1RestoreDatabaseRequest
|
1128
|
+
# @private
|
1129
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1130
|
+
property :backup, as: 'backup'
|
1131
|
+
property :database_id, as: 'databaseId'
|
1132
|
+
end
|
1133
|
+
end
|
1134
|
+
|
1135
|
+
class GoogleFirestoreAdminV1Stats
|
1136
|
+
# @private
|
1137
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1138
|
+
property :document_count, :numeric_string => true, as: 'documentCount'
|
1139
|
+
property :index_count, :numeric_string => true, as: 'indexCount'
|
1140
|
+
property :size_bytes, :numeric_string => true, as: 'sizeBytes'
|
1141
|
+
end
|
1142
|
+
end
|
1143
|
+
|
997
1144
|
class GoogleFirestoreAdminV1TtlConfig
|
998
1145
|
# @private
|
999
1146
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1014,6 +1161,13 @@ module Google
|
|
1014
1161
|
end
|
1015
1162
|
end
|
1016
1163
|
|
1164
|
+
class GoogleFirestoreAdminV1WeeklyRecurrence
|
1165
|
+
# @private
|
1166
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1167
|
+
property :day, as: 'day'
|
1168
|
+
end
|
1169
|
+
end
|
1170
|
+
|
1017
1171
|
class GoogleLongrunningCancelOperationRequest
|
1018
1172
|
# @private
|
1019
1173
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1295,6 +1449,7 @@ module Google
|
|
1295
1449
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1296
1450
|
property :documents, as: 'documents', class: Google::Apis::FirestoreV1::DocumentsTarget, decorator: Google::Apis::FirestoreV1::DocumentsTarget::Representation
|
1297
1451
|
|
1452
|
+
property :expected_count, as: 'expectedCount'
|
1298
1453
|
property :once, as: 'once'
|
1299
1454
|
property :query, as: 'query', class: Google::Apis::FirestoreV1::QueryTarget, decorator: Google::Apis::FirestoreV1::QueryTarget::Representation
|
1300
1455
|
|
@@ -308,6 +308,216 @@ module Google
|
|
308
308
|
execute_or_queue_command(command, &block)
|
309
309
|
end
|
310
310
|
|
311
|
+
# Create a new database by restore from an existing backup. The new database
|
312
|
+
# must be in the same cloud region or multi-region location as the existing
|
313
|
+
# backup. This behaves similar to FirestoreAdmin.CreateDatabase except instead
|
314
|
+
# of creating a new empty database, a new database is created with the database
|
315
|
+
# type, index configuration, and documents from an existing backup. The long-
|
316
|
+
# running operation can be used to track the progress of the restore, with the
|
317
|
+
# Operation's metadata field type being the RestoreDatabaseMetadata. The
|
318
|
+
# response type is the Database if the restore was successful. The new database
|
319
|
+
# is not readable or writeable until the LRO has completed. Cancelling the
|
320
|
+
# returned operation will stop the restore and delete the in-progress database,
|
321
|
+
# if the restore is still active.
|
322
|
+
# @param [String] parent
|
323
|
+
# Required. The project to restore the database in. Format is `projects/`
|
324
|
+
# project_id``.
|
325
|
+
# @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1RestoreDatabaseRequest] google_firestore_admin_v1_restore_database_request_object
|
326
|
+
# @param [String] fields
|
327
|
+
# Selector specifying which fields to include in a partial response.
|
328
|
+
# @param [String] quota_user
|
329
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
330
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
331
|
+
# @param [Google::Apis::RequestOptions] options
|
332
|
+
# Request-specific options
|
333
|
+
#
|
334
|
+
# @yield [result, err] Result & error if block supplied
|
335
|
+
# @yieldparam result [Google::Apis::FirestoreV1::GoogleLongrunningOperation] parsed result object
|
336
|
+
# @yieldparam err [StandardError] error object if request failed
|
337
|
+
#
|
338
|
+
# @return [Google::Apis::FirestoreV1::GoogleLongrunningOperation]
|
339
|
+
#
|
340
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
341
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
342
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
343
|
+
def restore_project_database(parent, google_firestore_admin_v1_restore_database_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
344
|
+
command = make_simple_command(:post, 'v1/{+parent}/databases:restore', options)
|
345
|
+
command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1RestoreDatabaseRequest::Representation
|
346
|
+
command.request_object = google_firestore_admin_v1_restore_database_request_object
|
347
|
+
command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
|
348
|
+
command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
|
349
|
+
command.params['parent'] = parent unless parent.nil?
|
350
|
+
command.query['fields'] = fields unless fields.nil?
|
351
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
352
|
+
execute_or_queue_command(command, &block)
|
353
|
+
end
|
354
|
+
|
355
|
+
# Creates a backup schedule on a database. At most two backup schedules can be
|
356
|
+
# configured on a database, one daily backup schedule with retention up to 7
|
357
|
+
# days and one weekly backup schedule with retention up to 14 weeks.
|
358
|
+
# @param [String] parent
|
359
|
+
# Required. The parent database. Format `projects/`project`/databases/`database``
|
360
|
+
# @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule] google_firestore_admin_v1_backup_schedule_object
|
361
|
+
# @param [String] fields
|
362
|
+
# Selector specifying which fields to include in a partial response.
|
363
|
+
# @param [String] quota_user
|
364
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
365
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
366
|
+
# @param [Google::Apis::RequestOptions] options
|
367
|
+
# Request-specific options
|
368
|
+
#
|
369
|
+
# @yield [result, err] Result & error if block supplied
|
370
|
+
# @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule] parsed result object
|
371
|
+
# @yieldparam err [StandardError] error object if request failed
|
372
|
+
#
|
373
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule]
|
374
|
+
#
|
375
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
376
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
377
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
378
|
+
def create_project_database_backup_schedule(parent, google_firestore_admin_v1_backup_schedule_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
379
|
+
command = make_simple_command(:post, 'v1/{+parent}/backupSchedules', options)
|
380
|
+
command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule::Representation
|
381
|
+
command.request_object = google_firestore_admin_v1_backup_schedule_object
|
382
|
+
command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule::Representation
|
383
|
+
command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule
|
384
|
+
command.params['parent'] = parent unless parent.nil?
|
385
|
+
command.query['fields'] = fields unless fields.nil?
|
386
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
387
|
+
execute_or_queue_command(command, &block)
|
388
|
+
end
|
389
|
+
|
390
|
+
# Deletes a backup schedule.
|
391
|
+
# @param [String] name
|
392
|
+
# Required. The name of backup schedule. Format `projects/`project`/databases/`
|
393
|
+
# database`/backupSchedules/`backup_schedule``
|
394
|
+
# @param [String] fields
|
395
|
+
# Selector specifying which fields to include in a partial response.
|
396
|
+
# @param [String] quota_user
|
397
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
398
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
399
|
+
# @param [Google::Apis::RequestOptions] options
|
400
|
+
# Request-specific options
|
401
|
+
#
|
402
|
+
# @yield [result, err] Result & error if block supplied
|
403
|
+
# @yieldparam result [Google::Apis::FirestoreV1::Empty] parsed result object
|
404
|
+
# @yieldparam err [StandardError] error object if request failed
|
405
|
+
#
|
406
|
+
# @return [Google::Apis::FirestoreV1::Empty]
|
407
|
+
#
|
408
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
409
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
410
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
411
|
+
def delete_project_database_backup_schedule(name, fields: nil, quota_user: nil, options: nil, &block)
|
412
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
413
|
+
command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
|
414
|
+
command.response_class = Google::Apis::FirestoreV1::Empty
|
415
|
+
command.params['name'] = name unless name.nil?
|
416
|
+
command.query['fields'] = fields unless fields.nil?
|
417
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
418
|
+
execute_or_queue_command(command, &block)
|
419
|
+
end
|
420
|
+
|
421
|
+
# Gets information about a backup schedule.
|
422
|
+
# @param [String] name
|
423
|
+
# Required. The name of the backup schedule. Format `projects/`project`/
|
424
|
+
# databases/`database`/backupSchedules/`backup_schedule``
|
425
|
+
# @param [String] fields
|
426
|
+
# Selector specifying which fields to include in a partial response.
|
427
|
+
# @param [String] quota_user
|
428
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
429
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
430
|
+
# @param [Google::Apis::RequestOptions] options
|
431
|
+
# Request-specific options
|
432
|
+
#
|
433
|
+
# @yield [result, err] Result & error if block supplied
|
434
|
+
# @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule] parsed result object
|
435
|
+
# @yieldparam err [StandardError] error object if request failed
|
436
|
+
#
|
437
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule]
|
438
|
+
#
|
439
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
440
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
441
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
442
|
+
def get_project_database_backup_schedule(name, fields: nil, quota_user: nil, options: nil, &block)
|
443
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
444
|
+
command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule::Representation
|
445
|
+
command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule
|
446
|
+
command.params['name'] = name unless name.nil?
|
447
|
+
command.query['fields'] = fields unless fields.nil?
|
448
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
449
|
+
execute_or_queue_command(command, &block)
|
450
|
+
end
|
451
|
+
|
452
|
+
# List backup schedules.
|
453
|
+
# @param [String] parent
|
454
|
+
# Required. The parent database. Format is `projects/`project`/databases/`
|
455
|
+
# database``.
|
456
|
+
# @param [String] fields
|
457
|
+
# Selector specifying which fields to include in a partial response.
|
458
|
+
# @param [String] quota_user
|
459
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
460
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
461
|
+
# @param [Google::Apis::RequestOptions] options
|
462
|
+
# Request-specific options
|
463
|
+
#
|
464
|
+
# @yield [result, err] Result & error if block supplied
|
465
|
+
# @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupSchedulesResponse] parsed result object
|
466
|
+
# @yieldparam err [StandardError] error object if request failed
|
467
|
+
#
|
468
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupSchedulesResponse]
|
469
|
+
#
|
470
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
471
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
472
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
473
|
+
def list_project_database_backup_schedules(parent, fields: nil, quota_user: nil, options: nil, &block)
|
474
|
+
command = make_simple_command(:get, 'v1/{+parent}/backupSchedules', options)
|
475
|
+
command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupSchedulesResponse::Representation
|
476
|
+
command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupSchedulesResponse
|
477
|
+
command.params['parent'] = parent unless parent.nil?
|
478
|
+
command.query['fields'] = fields unless fields.nil?
|
479
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
480
|
+
execute_or_queue_command(command, &block)
|
481
|
+
end
|
482
|
+
|
483
|
+
# Updates a backup schedule.
|
484
|
+
# @param [String] name
|
485
|
+
# Output only. The unique backup schedule identifier across all locations and
|
486
|
+
# databases for the given project. This will be auto-assigned. Format is `
|
487
|
+
# projects/`project`/databases/`database`/backupSchedules/`backup_schedule``
|
488
|
+
# @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule] google_firestore_admin_v1_backup_schedule_object
|
489
|
+
# @param [String] update_mask
|
490
|
+
# The list of fields to be updated.
|
491
|
+
# @param [String] fields
|
492
|
+
# Selector specifying which fields to include in a partial response.
|
493
|
+
# @param [String] quota_user
|
494
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
495
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
496
|
+
# @param [Google::Apis::RequestOptions] options
|
497
|
+
# Request-specific options
|
498
|
+
#
|
499
|
+
# @yield [result, err] Result & error if block supplied
|
500
|
+
# @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule] parsed result object
|
501
|
+
# @yieldparam err [StandardError] error object if request failed
|
502
|
+
#
|
503
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule]
|
504
|
+
#
|
505
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
506
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
507
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
508
|
+
def patch_project_database_backup_schedule(name, google_firestore_admin_v1_backup_schedule_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
509
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
510
|
+
command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule::Representation
|
511
|
+
command.request_object = google_firestore_admin_v1_backup_schedule_object
|
512
|
+
command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule::Representation
|
513
|
+
command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule
|
514
|
+
command.params['name'] = name unless name.nil?
|
515
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
516
|
+
command.query['fields'] = fields unless fields.nil?
|
517
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
518
|
+
execute_or_queue_command(command, &block)
|
519
|
+
end
|
520
|
+
|
311
521
|
# Gets the metadata and configuration for a Field.
|
312
522
|
# @param [String] name
|
313
523
|
# Required. A name of the form `projects/`project_id`/databases/`database_id`/
|
@@ -1519,6 +1729,101 @@ module Google
|
|
1519
1729
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1520
1730
|
execute_or_queue_command(command, &block)
|
1521
1731
|
end
|
1732
|
+
|
1733
|
+
# Deletes a backup.
|
1734
|
+
# @param [String] name
|
1735
|
+
# Required. Name of the backup to delete. format is `projects/`project`/
|
1736
|
+
# locations/`location`/backups/`backup``.
|
1737
|
+
# @param [String] fields
|
1738
|
+
# Selector specifying which fields to include in a partial response.
|
1739
|
+
# @param [String] quota_user
|
1740
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1741
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1742
|
+
# @param [Google::Apis::RequestOptions] options
|
1743
|
+
# Request-specific options
|
1744
|
+
#
|
1745
|
+
# @yield [result, err] Result & error if block supplied
|
1746
|
+
# @yieldparam result [Google::Apis::FirestoreV1::Empty] parsed result object
|
1747
|
+
# @yieldparam err [StandardError] error object if request failed
|
1748
|
+
#
|
1749
|
+
# @return [Google::Apis::FirestoreV1::Empty]
|
1750
|
+
#
|
1751
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1752
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1753
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1754
|
+
def delete_project_location_backup(name, fields: nil, quota_user: nil, options: nil, &block)
|
1755
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
1756
|
+
command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
|
1757
|
+
command.response_class = Google::Apis::FirestoreV1::Empty
|
1758
|
+
command.params['name'] = name unless name.nil?
|
1759
|
+
command.query['fields'] = fields unless fields.nil?
|
1760
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1761
|
+
execute_or_queue_command(command, &block)
|
1762
|
+
end
|
1763
|
+
|
1764
|
+
# Gets information about a backup.
|
1765
|
+
# @param [String] name
|
1766
|
+
# Required. Name of the backup to fetch. Format is `projects/`project`/locations/
|
1767
|
+
# `location`/backups/`backup``.
|
1768
|
+
# @param [String] fields
|
1769
|
+
# Selector specifying which fields to include in a partial response.
|
1770
|
+
# @param [String] quota_user
|
1771
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1772
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1773
|
+
# @param [Google::Apis::RequestOptions] options
|
1774
|
+
# Request-specific options
|
1775
|
+
#
|
1776
|
+
# @yield [result, err] Result & error if block supplied
|
1777
|
+
# @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup] parsed result object
|
1778
|
+
# @yieldparam err [StandardError] error object if request failed
|
1779
|
+
#
|
1780
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup]
|
1781
|
+
#
|
1782
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1783
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1784
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1785
|
+
def get_project_location_backup(name, fields: nil, quota_user: nil, options: nil, &block)
|
1786
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
1787
|
+
command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup::Representation
|
1788
|
+
command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup
|
1789
|
+
command.params['name'] = name unless name.nil?
|
1790
|
+
command.query['fields'] = fields unless fields.nil?
|
1791
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1792
|
+
execute_or_queue_command(command, &block)
|
1793
|
+
end
|
1794
|
+
|
1795
|
+
# Lists all the backups.
|
1796
|
+
# @param [String] parent
|
1797
|
+
# Required. The location to list backups from. Format is `projects/`project`/
|
1798
|
+
# locations/`location``. Use ``location` = '-'` to list backups from all
|
1799
|
+
# locations for the given project. This allows listing backups from a single
|
1800
|
+
# location or from all locations.
|
1801
|
+
# @param [String] fields
|
1802
|
+
# Selector specifying which fields to include in a partial response.
|
1803
|
+
# @param [String] quota_user
|
1804
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1805
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1806
|
+
# @param [Google::Apis::RequestOptions] options
|
1807
|
+
# Request-specific options
|
1808
|
+
#
|
1809
|
+
# @yield [result, err] Result & error if block supplied
|
1810
|
+
# @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupsResponse] parsed result object
|
1811
|
+
# @yieldparam err [StandardError] error object if request failed
|
1812
|
+
#
|
1813
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupsResponse]
|
1814
|
+
#
|
1815
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1816
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1817
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1818
|
+
def list_project_location_backups(parent, fields: nil, quota_user: nil, options: nil, &block)
|
1819
|
+
command = make_simple_command(:get, 'v1/{+parent}/backups', options)
|
1820
|
+
command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupsResponse::Representation
|
1821
|
+
command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupsResponse
|
1822
|
+
command.params['parent'] = parent unless parent.nil?
|
1823
|
+
command.query['fields'] = fields unless fields.nil?
|
1824
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1825
|
+
execute_or_queue_command(command, &block)
|
1826
|
+
end
|
1522
1827
|
|
1523
1828
|
protected
|
1524
1829
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
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.40.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-05-14 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.40.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|