google-apis-firestore_v1 0.29.0 → 0.30.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ef54838ef632922a9329bb1631550cd26a01bdd927ff458229284657e81810e8
4
- data.tar.gz: 07ee97b9393f9c5855ea66c91f59084697b3599405aba34cc01eee0d94137cbb
3
+ metadata.gz: 8eba1049564a84a181ad74b387ea673d94ae63e2fcd72db165742f8092c14080
4
+ data.tar.gz: d385e45f249a69d70de4340baf181295c1ef0cf1059b202dd1dfdf3ef985f2a5
5
5
  SHA512:
6
- metadata.gz: 875c68e281c57ab21903e3aaf9d08a3ae220f70c88493d744cac24ba6f2d06f6e1c475d46ed09f37e5cf8d68bfd8fe4ec1eae48d1e41f952746c047dc8c7a68f
7
- data.tar.gz: cc71211fb81f6b51eb941e33196faac1617d84133f7ceb70a9b5e30205b3ede62d43b0a8163df5526b294cc48e3841801a6e899a5405adb4f6ded5aa70a82325
6
+ metadata.gz: bdaff76ddbad8fa52ad886afa1d24f5792ee92497c32c6bbcca946de9dac97ece2832ce165274a329df28cfdb5039d9ff342256e67057bd2210f34c8eb882940
7
+ data.tar.gz: 224d48cf491bd819767538bd9295e4ed31e6189e817878a2a444af6fd7f011fe63e00951cebe868f49dfaf3ee91a1d203e51462d8fa440e4310a470504b665cc
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-firestore_v1
2
2
 
3
+ ### v0.30.0 (2022-12-15)
4
+
5
+ * Regenerated from discovery document revision 20221210
6
+
3
7
  ### v0.29.0 (2022-11-04)
4
8
 
5
9
  * Regenerated from discovery document revision 20221029
@@ -988,15 +988,6 @@ module Google
988
988
  # @return [Array<String>]
989
989
  attr_accessor :collection_ids
990
990
 
991
- # An empty list represents all namespaces. This is the preferred usage for
992
- # databases that don't use namespaces. An empty string element represents the
993
- # default namespace. This should be used if the database has data in non-default
994
- # namespaces, but doesn't want to include them. Each namespace in this list must
995
- # be unique.
996
- # Corresponds to the JSON property `namespaceIds`
997
- # @return [Array<String>]
998
- attr_accessor :namespace_ids
999
-
1000
991
  # The output URI. Currently only supports Google Cloud Storage URIs of the form:
1001
992
  # `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the
1002
993
  # Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud
@@ -1015,7 +1006,6 @@ module Google
1015
1006
  # Update properties of this object
1016
1007
  def update!(**args)
1017
1008
  @collection_ids = args[:collection_ids] if args.key?(:collection_ids)
1018
- @namespace_ids = args[:namespace_ids] if args.key?(:namespace_ids)
1019
1009
  @output_uri_prefix = args[:output_uri_prefix] if args.key?(:output_uri_prefix)
1020
1010
  end
1021
1011
  end
@@ -1238,15 +1228,6 @@ module Google
1238
1228
  # @return [String]
1239
1229
  attr_accessor :input_uri_prefix
1240
1230
 
1241
- # An empty list represents all namespaces. This is the preferred usage for
1242
- # databases that don't use namespaces. An empty string element represents the
1243
- # default namespace. This should be used if the database has data in non-default
1244
- # namespaces, but doesn't want to include them. Each namespace in this list must
1245
- # be unique.
1246
- # Corresponds to the JSON property `namespaceIds`
1247
- # @return [Array<String>]
1248
- attr_accessor :namespace_ids
1249
-
1250
1231
  def initialize(**args)
1251
1232
  update!(**args)
1252
1233
  end
@@ -1255,7 +1236,6 @@ module Google
1255
1236
  def update!(**args)
1256
1237
  @collection_ids = args[:collection_ids] if args.key?(:collection_ids)
1257
1238
  @input_uri_prefix = args[:input_uri_prefix] if args.key?(:input_uri_prefix)
1258
- @namespace_ids = args[:namespace_ids] if args.key?(:namespace_ids)
1259
1239
  end
1260
1240
  end
1261
1241
 
@@ -1840,7 +1820,8 @@ module Google
1840
1820
  # @return [Array<Google::Apis::FirestoreV1::Document>]
1841
1821
  attr_accessor :documents
1842
1822
 
1843
- # The next page token.
1823
+ # A token to retrieve the next page of documents. If this field is omitted,
1824
+ # there are no subsequent pages.
1844
1825
  # Corresponds to the JSON property `nextPageToken`
1845
1826
  # @return [String]
1846
1827
  attr_accessor :next_page_token
@@ -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.29.0"
19
+ GEM_VERSION = "0.30.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.11.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20221029"
25
+ REVISION = "20221210"
26
26
  end
27
27
  end
28
28
  end
@@ -828,7 +828,6 @@ module Google
828
828
  # @private
829
829
  class Representation < Google::Apis::Core::JsonRepresentation
830
830
  collection :collection_ids, as: 'collectionIds'
831
- collection :namespace_ids, as: 'namespaceIds'
832
831
  property :output_uri_prefix, as: 'outputUriPrefix'
833
832
  end
834
833
  end
@@ -889,7 +888,6 @@ module Google
889
888
  class Representation < Google::Apis::Core::JsonRepresentation
890
889
  collection :collection_ids, as: 'collectionIds'
891
890
  property :input_uri_prefix, as: 'inputUriPrefix'
892
- collection :namespace_ids, as: 'namespaceIds'
893
891
  end
894
892
  end
895
893
 
@@ -90,6 +90,49 @@ module Google
90
90
  execute_or_queue_command(command, &block)
91
91
  end
92
92
 
93
+ # Deletes a database.
94
+ # @param [String] name
95
+ # Required. A name of the form `projects/`project_id`/databases/`database_id``
96
+ # @param [Boolean] allow_missing
97
+ # If set to true and the Database is not found, the request will succeed but no
98
+ # action will be taken.
99
+ # @param [String] etag
100
+ # The current etag of the Database. If an etag is provided and does not match
101
+ # the current etag of the database, deletion will be blocked and a
102
+ # FAILED_PRECONDITION error will be returned.
103
+ # @param [Boolean] validate_only
104
+ # If set, validate the request and preview the response, but do not actually
105
+ # delete the database.
106
+ # @param [String] fields
107
+ # Selector specifying which fields to include in a partial response.
108
+ # @param [String] quota_user
109
+ # Available to use for quota purposes for server-side applications. Can be any
110
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
111
+ # @param [Google::Apis::RequestOptions] options
112
+ # Request-specific options
113
+ #
114
+ # @yield [result, err] Result & error if block supplied
115
+ # @yieldparam result [Google::Apis::FirestoreV1::GoogleLongrunningOperation] parsed result object
116
+ # @yieldparam err [StandardError] error object if request failed
117
+ #
118
+ # @return [Google::Apis::FirestoreV1::GoogleLongrunningOperation]
119
+ #
120
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
121
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
122
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
123
+ def delete_project_database(name, allow_missing: nil, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
124
+ command = make_simple_command(:delete, 'v1/{+name}', options)
125
+ command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
126
+ command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
127
+ command.params['name'] = name unless name.nil?
128
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
129
+ command.query['etag'] = etag unless etag.nil?
130
+ command.query['validateOnly'] = validate_only unless validate_only.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
+
93
136
  # Exports a copy of all or a subset of documents from Google Cloud Firestore to
94
137
  # another storage system, such as Google Cloud Storage. Recent updates to
95
138
  # documents may not be reflected in the export. The export occurs in the
@@ -822,28 +865,35 @@ module Google
822
865
  # databases/my-database/documents` or `projects/my-project/databases/my-database/
823
866
  # documents/chatrooms/my-chatroom`
824
867
  # @param [String] collection_id
825
- # Required. The collection ID, relative to `parent`, to list. For example: `
826
- # chatrooms` or `messages`.
868
+ # Optional. The collection ID, relative to `parent`, to list. For example: `
869
+ # chatrooms` or `messages`. This is optional, and when not provided, Firestore
870
+ # will list documents from all collections under the provided `parent`.
827
871
  # @param [Array<String>, String] mask_field_paths
828
872
  # The list of field paths in the mask. See Document.fields for a field path
829
873
  # syntax reference.
830
874
  # @param [String] order_by
831
- # The order to sort results by. For example: `priority desc, name`.
875
+ # Optional. The optional ordering of the documents to return. For example: `
876
+ # priority desc, __name__ desc`. This mirrors the `ORDER BY` used in Firestore
877
+ # queries but in a string representation. When absent, documents are ordered
878
+ # based on `__name__ ASC`.
832
879
  # @param [Fixnum] page_size
833
- # The maximum number of documents to return.
880
+ # Optional. The maximum number of documents to return in a single response.
881
+ # Firestore may return fewer than this value.
834
882
  # @param [String] page_token
835
- # The `next_page_token` value returned from a previous List request, if any.
883
+ # Optional. A page token, received from a previous `ListDocuments` response.
884
+ # Provide this to retrieve the subsequent page. When paginating, all other
885
+ # parameters (with the exception of `page_size`) must match the values set in
886
+ # the request that generated the page token.
836
887
  # @param [String] read_time
837
- # Reads documents as they were at the given time. This may not be older than 270
838
- # seconds.
888
+ # Perform the read at the provided time. This may not be older than 270 seconds.
839
889
  # @param [Boolean] show_missing
840
- # If the list should show missing documents. A missing document is a document
841
- # that does not exist but has sub-documents. These documents will be returned
842
- # with a key but will not have fields, Document.create_time, or Document.
843
- # update_time set. Requests with `show_missing` may not specify `where` or `
844
- # order_by`.
890
+ # If the list should show missing documents. A document is missing if it does
891
+ # not exist, but there are sub-documents nested underneath it. When true, such
892
+ # missing documents will be returned with a key but will not have fields, `
893
+ # create_time`, or `update_time` set. Requests with `show_missing` may not
894
+ # specify `where` or `order_by`.
845
895
  # @param [String] transaction
846
- # Reads documents in a transaction.
896
+ # Perform the read as part of an already active transaction.
847
897
  # @param [String] fields
848
898
  # Selector specifying which fields to include in a partial response.
849
899
  # @param [String] quota_user
@@ -922,28 +972,35 @@ module Google
922
972
  # databases/my-database/documents` or `projects/my-project/databases/my-database/
923
973
  # documents/chatrooms/my-chatroom`
924
974
  # @param [String] collection_id
925
- # Required. The collection ID, relative to `parent`, to list. For example: `
926
- # chatrooms` or `messages`.
975
+ # Optional. The collection ID, relative to `parent`, to list. For example: `
976
+ # chatrooms` or `messages`. This is optional, and when not provided, Firestore
977
+ # will list documents from all collections under the provided `parent`.
927
978
  # @param [Array<String>, String] mask_field_paths
928
979
  # The list of field paths in the mask. See Document.fields for a field path
929
980
  # syntax reference.
930
981
  # @param [String] order_by
931
- # The order to sort results by. For example: `priority desc, name`.
982
+ # Optional. The optional ordering of the documents to return. For example: `
983
+ # priority desc, __name__ desc`. This mirrors the `ORDER BY` used in Firestore
984
+ # queries but in a string representation. When absent, documents are ordered
985
+ # based on `__name__ ASC`.
932
986
  # @param [Fixnum] page_size
933
- # The maximum number of documents to return.
987
+ # Optional. The maximum number of documents to return in a single response.
988
+ # Firestore may return fewer than this value.
934
989
  # @param [String] page_token
935
- # The `next_page_token` value returned from a previous List request, if any.
990
+ # Optional. A page token, received from a previous `ListDocuments` response.
991
+ # Provide this to retrieve the subsequent page. When paginating, all other
992
+ # parameters (with the exception of `page_size`) must match the values set in
993
+ # the request that generated the page token.
936
994
  # @param [String] read_time
937
- # Reads documents as they were at the given time. This may not be older than 270
938
- # seconds.
995
+ # Perform the read at the provided time. This may not be older than 270 seconds.
939
996
  # @param [Boolean] show_missing
940
- # If the list should show missing documents. A missing document is a document
941
- # that does not exist but has sub-documents. These documents will be returned
942
- # with a key but will not have fields, Document.create_time, or Document.
943
- # update_time set. Requests with `show_missing` may not specify `where` or `
944
- # order_by`.
997
+ # If the list should show missing documents. A document is missing if it does
998
+ # not exist, but there are sub-documents nested underneath it. When true, such
999
+ # missing documents will be returned with a key but will not have fields, `
1000
+ # create_time`, or `update_time` set. Requests with `show_missing` may not
1001
+ # specify `where` or `order_by`.
945
1002
  # @param [String] transaction
946
- # Reads documents in a transaction.
1003
+ # Perform the read as part of an already active transaction.
947
1004
  # @param [String] fields
948
1005
  # Selector specifying which fields to include in a partial response.
949
1006
  # @param [String] quota_user
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.29.0
4
+ version: 0.30.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: 2022-11-07 00:00:00.000000000 Z
11
+ date: 2023-01-04 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.29.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.30.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: []