google-apis-firestore_v1beta1 0.11.0 → 0.12.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: fe8bc758aad394a106b3a6fedb2b6f5d491c1f81c3c1386aadf1aa76de9372eb
|
4
|
+
data.tar.gz: d1608ef6e175d8f7a88106e3e45249c8218f1d0044dc8fefdcdc951af92f8ccb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 41b1f454a2ba2e1729d7cf8bcf6ffe4b7e3c8f1ba8a4ba87bd9ca03814ebc8f98c0dde556e57d563d9879fb7944cea026ae0a622d097fe8520938e10417c99e7
|
7
|
+
data.tar.gz: 06f5862f99e8cf3c582752e7d2b506b39c8804872016ddc2ddf4135035642f62b2ce5076fb29eb16c0c167318633d50e2a23e418d5513d1792ae589306799b08
|
data/CHANGELOG.md
CHANGED
@@ -1735,6 +1735,13 @@ module Google
|
|
1735
1735
|
# @return [Google::Apis::FirestoreV1beta1::Document]
|
1736
1736
|
attr_accessor :document
|
1737
1737
|
|
1738
|
+
# If present, Firestore has completely finished the request and no more
|
1739
|
+
# documents will be returned.
|
1740
|
+
# Corresponds to the JSON property `done`
|
1741
|
+
# @return [Boolean]
|
1742
|
+
attr_accessor :done
|
1743
|
+
alias_method :done?, :done
|
1744
|
+
|
1738
1745
|
# The time at which the document was read. This may be monotonically increasing;
|
1739
1746
|
# in this case, the previous documents in the result stream are guaranteed not
|
1740
1747
|
# to have changed between their `read_time` and this one. If the query returns
|
@@ -1765,6 +1772,7 @@ module Google
|
|
1765
1772
|
# Update properties of this object
|
1766
1773
|
def update!(**args)
|
1767
1774
|
@document = args[:document] if args.key?(:document)
|
1775
|
+
@done = args[:done] if args.key?(:done)
|
1768
1776
|
@read_time = args[:read_time] if args.key?(:read_time)
|
1769
1777
|
@skipped_results = args[:skipped_results] if args.key?(:skipped_results)
|
1770
1778
|
@transaction = args[:transaction] if args.key?(:transaction)
|
@@ -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.
|
19
|
+
GEM_VERSION = "0.12.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.4.1"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20220305"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -943,6 +943,7 @@ module Google
|
|
943
943
|
class Representation < Google::Apis::Core::JsonRepresentation
|
944
944
|
property :document, as: 'document', class: Google::Apis::FirestoreV1beta1::Document, decorator: Google::Apis::FirestoreV1beta1::Document::Representation
|
945
945
|
|
946
|
+
property :done, as: 'done'
|
946
947
|
property :read_time, as: 'readTime'
|
947
948
|
property :skipped_results, as: 'skippedResults'
|
948
949
|
property :transaction, :base64 => true, as: 'transaction'
|
@@ -497,6 +497,71 @@ module Google
|
|
497
497
|
execute_or_queue_command(command, &block)
|
498
498
|
end
|
499
499
|
|
500
|
+
# Lists documents.
|
501
|
+
# @param [String] parent
|
502
|
+
# Required. The parent resource name. In the format: `projects/`project_id`/
|
503
|
+
# databases/`database_id`/documents` or `projects/`project_id`/databases/`
|
504
|
+
# database_id`/documents/`document_path``. For example: `projects/my-project/
|
505
|
+
# databases/my-database/documents` or `projects/my-project/databases/my-database/
|
506
|
+
# documents/chatrooms/my-chatroom`
|
507
|
+
# @param [String] collection_id
|
508
|
+
# Required. The collection ID, relative to `parent`, to list. For example: `
|
509
|
+
# chatrooms` or `messages`.
|
510
|
+
# @param [Array<String>, String] mask_field_paths
|
511
|
+
# The list of field paths in the mask. See Document.fields for a field path
|
512
|
+
# syntax reference.
|
513
|
+
# @param [String] order_by
|
514
|
+
# The order to sort results by. For example: `priority desc, name`.
|
515
|
+
# @param [Fixnum] page_size
|
516
|
+
# The maximum number of documents to return.
|
517
|
+
# @param [String] page_token
|
518
|
+
# The `next_page_token` value returned from a previous List request, if any.
|
519
|
+
# @param [String] read_time
|
520
|
+
# Reads documents as they were at the given time. This may not be older than 270
|
521
|
+
# seconds.
|
522
|
+
# @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`.
|
528
|
+
# @param [String] transaction
|
529
|
+
# Reads documents in a transaction.
|
530
|
+
# @param [String] fields
|
531
|
+
# Selector specifying which fields to include in a partial response.
|
532
|
+
# @param [String] quota_user
|
533
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
534
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
535
|
+
# @param [Google::Apis::RequestOptions] options
|
536
|
+
# Request-specific options
|
537
|
+
#
|
538
|
+
# @yield [result, err] Result & error if block supplied
|
539
|
+
# @yieldparam result [Google::Apis::FirestoreV1beta1::ListDocumentsResponse] parsed result object
|
540
|
+
# @yieldparam err [StandardError] error object if request failed
|
541
|
+
#
|
542
|
+
# @return [Google::Apis::FirestoreV1beta1::ListDocumentsResponse]
|
543
|
+
#
|
544
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
545
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
546
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
547
|
+
def list_project_database_document_documents(parent, collection_id, mask_field_paths: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
|
548
|
+
command = make_simple_command(:get, 'v1beta1/{+parent}/{collectionId}', options)
|
549
|
+
command.response_representation = Google::Apis::FirestoreV1beta1::ListDocumentsResponse::Representation
|
550
|
+
command.response_class = Google::Apis::FirestoreV1beta1::ListDocumentsResponse
|
551
|
+
command.params['parent'] = parent unless parent.nil?
|
552
|
+
command.params['collectionId'] = collection_id unless collection_id.nil?
|
553
|
+
command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
|
554
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
555
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
556
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
557
|
+
command.query['readTime'] = read_time unless read_time.nil?
|
558
|
+
command.query['showMissing'] = show_missing unless show_missing.nil?
|
559
|
+
command.query['transaction'] = transaction unless transaction.nil?
|
560
|
+
command.query['fields'] = fields unless fields.nil?
|
561
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
562
|
+
execute_or_queue_command(command, &block)
|
563
|
+
end
|
564
|
+
|
500
565
|
# Listens to changes.
|
501
566
|
# @param [String] database
|
502
567
|
# Required. The database name. In the format: `projects/`project_id`/databases/`
|
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.
|
4
|
+
version: 0.12.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-03-
|
11
|
+
date: 2022-03-21 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.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.12.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: []
|