google-apis-firestore_v1 0.28.0 → 0.30.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: 56754b1259d90ecbc12eae2441505aaabf0aabbddc39c7cbd8ecb1d2c7851e41
4
- data.tar.gz: e87dffa8f484e736ae95702a9d9704e5feb66f82ef4bd173474d30986e101b12
3
+ metadata.gz: 8eba1049564a84a181ad74b387ea673d94ae63e2fcd72db165742f8092c14080
4
+ data.tar.gz: d385e45f249a69d70de4340baf181295c1ef0cf1059b202dd1dfdf3ef985f2a5
5
5
  SHA512:
6
- metadata.gz: 7a55df4a172bf30a5924ce4c277f640ae39bf5b075e67b48f1e7291d1fec3c297df1886e1c014274e90c3b0863508abd851d46fcfb95bccf0a5a2449126747e6
7
- data.tar.gz: 2d0c4b0f9f1715769f528db02013ac2a50ee49f9557f135331f0d46c9abc3e41d19a6bbc480cc00f43a97ecfa1091bc529068f04e76d3ff4e932c0f721b5fe20
6
+ metadata.gz: bdaff76ddbad8fa52ad886afa1d24f5792ee92497c32c6bbcca946de9dac97ece2832ce165274a329df28cfdb5039d9ff342256e67057bd2210f34c8eb882940
7
+ data.tar.gz: 224d48cf491bd819767538bd9295e4ed31e6189e817878a2a444af6fd7f011fe63e00951cebe868f49dfaf3ee91a1d203e51462d8fa440e4310a470504b665cc
data/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
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
+
7
+ ### v0.29.0 (2022-11-04)
8
+
9
+ * Regenerated from discovery document revision 20221029
10
+ * Regenerated using generator version 0.11.0
11
+
3
12
  ### v0.28.0 (2022-09-28)
4
13
 
5
14
  * Regenerated from discovery document revision 20220915
@@ -1244,6 +1244,11 @@ module Google
1244
1244
  class GoogleFirestoreAdminV1Index
1245
1245
  include Google::Apis::Core::Hashable
1246
1246
 
1247
+ # The API scope supported by this index.
1248
+ # Corresponds to the JSON property `apiScope`
1249
+ # @return [String]
1250
+ attr_accessor :api_scope
1251
+
1247
1252
  # The fields supported by this index. For composite indexes, this requires a
1248
1253
  # minimum of 2 and a maximum of 100 fields. The last field entry is always for
1249
1254
  # the field path `__name__`. If, on creation, `__name__` was not specified as
@@ -1285,6 +1290,7 @@ module Google
1285
1290
 
1286
1291
  # Update properties of this object
1287
1292
  def update!(**args)
1293
+ @api_scope = args[:api_scope] if args.key?(:api_scope)
1288
1294
  @fields = args[:fields] if args.key?(:fields)
1289
1295
  @name = args[:name] if args.key?(:name)
1290
1296
  @query_scope = args[:query_scope] if args.key?(:query_scope)
@@ -1814,7 +1820,8 @@ module Google
1814
1820
  # @return [Array<Google::Apis::FirestoreV1::Document>]
1815
1821
  attr_accessor :documents
1816
1822
 
1817
- # 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.
1818
1825
  # Corresponds to the JSON property `nextPageToken`
1819
1826
  # @return [String]
1820
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.28.0"
19
+ GEM_VERSION = "0.30.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.10.0"
22
+ GENERATOR_VERSION = "0.11.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220915"
25
+ REVISION = "20221210"
26
26
  end
27
27
  end
28
28
  end
@@ -894,6 +894,7 @@ module Google
894
894
  class GoogleFirestoreAdminV1Index
895
895
  # @private
896
896
  class Representation < Google::Apis::Core::JsonRepresentation
897
+ property :api_scope, as: 'apiScope'
897
898
  collection :fields, as: 'fields', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexField, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexField::Representation
898
899
 
899
900
  property :name, as: 'name'
@@ -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.28.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-10-03 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
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.9.0
19
+ version: 0.9.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.9.0
29
+ version: 0.9.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -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.28.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: []