google-apis-firestore_v1beta1 0.22.0 → 0.23.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: 1f41c5f8cb2c4352501f3979b11a74771fff7ce61dc33efc40b5e6a55121b104
4
- data.tar.gz: 2467620fc50ab37f19d50be286dfd5d15a369d0e5fe5ad6c3f2bed88f0aa6c04
3
+ metadata.gz: f866e4d39376eb610cc10ee7baab22312d0b095570271b8c7d30bf76f298050a
4
+ data.tar.gz: 6200f166f3f9e5663abff8bfd9fd9e0c12c7b5ee660d36756df60b092727ccb8
5
5
  SHA512:
6
- metadata.gz: 0cf6e7869ca48623402f927fc4ec4634c9743841602cfbea6848f856df88fd3c12b1c999ba6fc1f85056fab575cf70b0073726521e44aea43dfa0a15150fed4c
7
- data.tar.gz: aeb0863420c8645f3ac937812322feded589bd443b8aa255f98be3c9e37c157fcb64d1b5d83c7af98fee36f39bfc10056ae03cd59a1e0877a6292539c04136ce
6
+ metadata.gz: e4bf2b7665330ddeb0717a6f2c712b049ee11c41eebcae7a937bbb63d27dc24e0911b153893847be166859385f181b450799cefd7e4679ffc202a7ab40f6d55d
7
+ data.tar.gz: 710ed2ee16e2b1c791dfce16b508b852ce6ce333b617d62af0d8f5e91a559617202021e4f177ea3dec59570928d526bbc05ba3fdcd21771e3a671779b56aedba
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-firestore_v1beta1
2
2
 
3
+ ### v0.23.0 (2022-12-19)
4
+
5
+ * Regenerated from discovery document revision 20221210
6
+
3
7
  ### v0.22.0 (2022-10-28)
4
8
 
5
9
  * Regenerated using generator version 0.11.0
@@ -1401,7 +1401,8 @@ module Google
1401
1401
  # @return [Array<Google::Apis::FirestoreV1beta1::Document>]
1402
1402
  attr_accessor :documents
1403
1403
 
1404
- # The next page token.
1404
+ # A token to retrieve the next page of documents. If this field is omitted,
1405
+ # there are no subsequent pages.
1405
1406
  # Corresponds to the JSON property `nextPageToken`
1406
1407
  # @return [String]
1407
1408
  attr_accessor :next_page_token
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module FirestoreV1beta1
18
18
  # Version of the google-apis-firestore_v1beta1 gem
19
- GEM_VERSION = "0.22.0"
19
+ GEM_VERSION = "0.23.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 = "20220915"
25
+ REVISION = "20221210"
26
26
  end
27
27
  end
28
28
  end
@@ -405,28 +405,35 @@ module Google
405
405
  # databases/my-database/documents` or `projects/my-project/databases/my-database/
406
406
  # documents/chatrooms/my-chatroom`
407
407
  # @param [String] collection_id
408
- # Required. The collection ID, relative to `parent`, to list. For example: `
409
- # chatrooms` or `messages`.
408
+ # Optional. The collection ID, relative to `parent`, to list. For example: `
409
+ # chatrooms` or `messages`. This is optional, and when not provided, Firestore
410
+ # will list documents from all collections under the provided `parent`.
410
411
  # @param [Array<String>, String] mask_field_paths
411
412
  # The list of field paths in the mask. See Document.fields for a field path
412
413
  # syntax reference.
413
414
  # @param [String] order_by
414
- # The order to sort results by. For example: `priority desc, name`.
415
+ # Optional. The optional ordering of the documents to return. For example: `
416
+ # priority desc, __name__ desc`. This mirrors the `ORDER BY` used in Firestore
417
+ # queries but in a string representation. When absent, documents are ordered
418
+ # based on `__name__ ASC`.
415
419
  # @param [Fixnum] page_size
416
- # The maximum number of documents to return.
420
+ # Optional. The maximum number of documents to return in a single response.
421
+ # Firestore may return fewer than this value.
417
422
  # @param [String] page_token
418
- # The `next_page_token` value returned from a previous List request, if any.
423
+ # Optional. A page token, received from a previous `ListDocuments` response.
424
+ # Provide this to retrieve the subsequent page. When paginating, all other
425
+ # parameters (with the exception of `page_size`) must match the values set in
426
+ # the request that generated the page token.
419
427
  # @param [String] read_time
420
- # Reads documents as they were at the given time. This may not be older than 270
421
- # seconds.
428
+ # Perform the read at the provided time. This may not be older than 270 seconds.
422
429
  # @param [Boolean] show_missing
423
- # If the list should show missing documents. A missing document is a document
424
- # that does not exist but has sub-documents. These documents will be returned
425
- # with a key but will not have fields, Document.create_time, or Document.
426
- # update_time set. Requests with `show_missing` may not specify `where` or `
427
- # order_by`.
430
+ # If the list should show missing documents. A document is missing if it does
431
+ # not exist, but there are sub-documents nested underneath it. When true, such
432
+ # missing documents will be returned with a key but will not have fields, `
433
+ # create_time`, or `update_time` set. Requests with `show_missing` may not
434
+ # specify `where` or `order_by`.
428
435
  # @param [String] transaction
429
- # Reads documents in a transaction.
436
+ # Perform the read as part of an already active transaction.
430
437
  # @param [String] fields
431
438
  # Selector specifying which fields to include in a partial response.
432
439
  # @param [String] quota_user
@@ -505,28 +512,35 @@ module Google
505
512
  # databases/my-database/documents` or `projects/my-project/databases/my-database/
506
513
  # documents/chatrooms/my-chatroom`
507
514
  # @param [String] collection_id
508
- # Required. The collection ID, relative to `parent`, to list. For example: `
509
- # chatrooms` or `messages`.
515
+ # Optional. The collection ID, relative to `parent`, to list. For example: `
516
+ # chatrooms` or `messages`. This is optional, and when not provided, Firestore
517
+ # will list documents from all collections under the provided `parent`.
510
518
  # @param [Array<String>, String] mask_field_paths
511
519
  # The list of field paths in the mask. See Document.fields for a field path
512
520
  # syntax reference.
513
521
  # @param [String] order_by
514
- # The order to sort results by. For example: `priority desc, name`.
522
+ # Optional. The optional ordering of the documents to return. For example: `
523
+ # priority desc, __name__ desc`. This mirrors the `ORDER BY` used in Firestore
524
+ # queries but in a string representation. When absent, documents are ordered
525
+ # based on `__name__ ASC`.
515
526
  # @param [Fixnum] page_size
516
- # The maximum number of documents to return.
527
+ # Optional. The maximum number of documents to return in a single response.
528
+ # Firestore may return fewer than this value.
517
529
  # @param [String] page_token
518
- # The `next_page_token` value returned from a previous List request, if any.
530
+ # Optional. A page token, received from a previous `ListDocuments` response.
531
+ # Provide this to retrieve the subsequent page. When paginating, all other
532
+ # parameters (with the exception of `page_size`) must match the values set in
533
+ # the request that generated the page token.
519
534
  # @param [String] read_time
520
- # Reads documents as they were at the given time. This may not be older than 270
521
- # seconds.
535
+ # Perform the read at the provided time. This may not be older than 270 seconds.
522
536
  # @param [Boolean] show_missing
523
- # If the list should show missing documents. A missing document is a document
524
- # that does not exist but has sub-documents. These documents will be returned
525
- # with a key but will not have fields, Document.create_time, or Document.
526
- # update_time set. Requests with `show_missing` may not specify `where` or `
527
- # order_by`.
537
+ # If the list should show missing documents. A document is missing if it does
538
+ # not exist, but there are sub-documents nested underneath it. When true, such
539
+ # missing documents will be returned with a key but will not have fields, `
540
+ # create_time`, or `update_time` set. Requests with `show_missing` may not
541
+ # specify `where` or `order_by`.
528
542
  # @param [String] transaction
529
- # Reads documents in a transaction.
543
+ # Perform the read as part of an already active transaction.
530
544
  # @param [String] fields
531
545
  # Selector specifying which fields to include in a partial response.
532
546
  # @param [String] quota_user
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-firestore_v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.22.0
4
+ version: 0.23.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-31 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_v1beta1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.22.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.23.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1
63
63
  post_install_message:
64
64
  rdoc_options: []