google-apis-firestore_v1beta1 0.9.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: d931006a616017bb30530e32a2d60564b1900c42ab0a0cbb7c117be64d6ac9ee
4
- data.tar.gz: f60e2cec6b413e1b2207dbd1b6cc83241742f94fdf85b31449f109ba4508d7f8
3
+ metadata.gz: fe8bc758aad394a106b3a6fedb2b6f5d491c1f81c3c1386aadf1aa76de9372eb
4
+ data.tar.gz: d1608ef6e175d8f7a88106e3e45249c8218f1d0044dc8fefdcdc951af92f8ccb
5
5
  SHA512:
6
- metadata.gz: c48edb1d7badae7ea56cef3c03af4c4620ad5babd6a6b6b4bb6afae225d6dbfb5749a15072b1b008fe3288ff84a586fa60c19837326537dc0f0857d41fe83016
7
- data.tar.gz: d10a9e89421b590a2ab9d41a0d420452489835f838bab034d4bafa7ba6ece2ad283204e7959dbf7b2fec244865390efc429b77cf9ce43cf741c336c8595d38c4
6
+ metadata.gz: 41b1f454a2ba2e1729d7cf8bcf6ffe4b7e3c8f1ba8a4ba87bd9ca03814ebc8f98c0dde556e57d563d9879fb7944cea026ae0a622d097fe8520938e10417c99e7
7
+ data.tar.gz: 06f5862f99e8cf3c582752e7d2b506b39c8804872016ddc2ddf4135035642f62b2ce5076fb29eb16c0c167318633d50e2a23e418d5513d1792ae589306799b08
data/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Release history for google-apis-firestore_v1beta1
2
2
 
3
+ ### v0.12.0 (2022-03-19)
4
+
5
+ * Regenerated from discovery document revision 20220305
6
+
7
+ ### v0.11.0 (2022-03-04)
8
+
9
+ * Regenerated from discovery document revision 20220221
10
+
11
+ ### v0.10.0 (2022-01-21)
12
+
13
+ * Regenerated from discovery document revision 20220110
14
+ * Regenerated using generator version 0.4.1
15
+
3
16
  ### v0.9.0 (2021-12-14)
4
17
 
5
18
  * Unspecified changes
@@ -775,6 +775,19 @@ module Google
775
775
  end
776
776
  end
777
777
 
778
+ # Metadata related to the update database operation.
779
+ class GoogleFirestoreAdminV1UpdateDatabaseMetadata
780
+ include Google::Apis::Core::Hashable
781
+
782
+ def initialize(**args)
783
+ update!(**args)
784
+ end
785
+
786
+ # Update properties of this object
787
+ def update!(**args)
788
+ end
789
+ end
790
+
778
791
  # Metadata for ExportDocuments operations.
779
792
  class GoogleFirestoreAdminV1beta1ExportDocumentsMetadata
780
793
  include Google::Apis::Core::Hashable
@@ -1693,7 +1706,8 @@ module Google
1693
1706
  # @return [Google::Apis::FirestoreV1beta1::StructuredQuery]
1694
1707
  attr_accessor :structured_query
1695
1708
 
1696
- # Reads documents in a transaction.
1709
+ # Run the query within an already active transaction. The value here is the
1710
+ # opaque transaction ID to execute the query in.
1697
1711
  # Corresponds to the JSON property `transaction`
1698
1712
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
1699
1713
  # @return [String]
@@ -1721,6 +1735,13 @@ module Google
1721
1735
  # @return [Google::Apis::FirestoreV1beta1::Document]
1722
1736
  attr_accessor :document
1723
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
+
1724
1745
  # The time at which the document was read. This may be monotonically increasing;
1725
1746
  # in this case, the previous documents in the result stream are guaranteed not
1726
1747
  # to have changed between their `read_time` and this one. If the query returns
@@ -1751,6 +1772,7 @@ module Google
1751
1772
  # Update properties of this object
1752
1773
  def update!(**args)
1753
1774
  @document = args[:document] if args.key?(:document)
1775
+ @done = args[:done] if args.key?(:done)
1754
1776
  @read_time = args[:read_time] if args.key?(:read_time)
1755
1777
  @skipped_results = args[:skipped_results] if args.key?(:skipped_results)
1756
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.9.0"
19
+ GEM_VERSION = "0.12.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.4.0"
22
+ GENERATOR_VERSION = "0.4.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20211013"
25
+ REVISION = "20220305"
26
26
  end
27
27
  end
28
28
  end
@@ -172,6 +172,12 @@ module Google
172
172
  include Google::Apis::Core::JsonObjectSupport
173
173
  end
174
174
 
175
+ class GoogleFirestoreAdminV1UpdateDatabaseMetadata
176
+ class Representation < Google::Apis::Core::JsonRepresentation; end
177
+
178
+ include Google::Apis::Core::JsonObjectSupport
179
+ end
180
+
175
181
  class GoogleFirestoreAdminV1beta1ExportDocumentsMetadata
176
182
  class Representation < Google::Apis::Core::JsonRepresentation; end
177
183
 
@@ -652,6 +658,12 @@ module Google
652
658
  end
653
659
  end
654
660
 
661
+ class GoogleFirestoreAdminV1UpdateDatabaseMetadata
662
+ # @private
663
+ class Representation < Google::Apis::Core::JsonRepresentation
664
+ end
665
+ end
666
+
655
667
  class GoogleFirestoreAdminV1beta1ExportDocumentsMetadata
656
668
  # @private
657
669
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -931,6 +943,7 @@ module Google
931
943
  class Representation < Google::Apis::Core::JsonRepresentation
932
944
  property :document, as: 'document', class: Google::Apis::FirestoreV1beta1::Document, decorator: Google::Apis::FirestoreV1beta1::Document::Representation
933
945
 
946
+ property :done, as: 'done'
934
947
  property :read_time, as: 'readTime'
935
948
  property :skipped_results, as: 'skippedResults'
936
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.9.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-01-10 00:00:00.000000000 Z
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.9.0
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: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.3.4
78
+ rubygems_version: 3.3.5
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Cloud Firestore API V1beta1