google-cloud-firestore-v1 0.10.0 → 0.11.0

data/lib/google/cloud/firestore/v1/firestore/rest/client.rb

@@ -40,6 +40,9 @@ module Google
             # truly serverless apps.
             #
             class Client
+              # @private
+              DEFAULT_ENDPOINT_TEMPLATE = "firestore.$UNIVERSE_DOMAIN$"
+
               # @private
               attr_reader :firestore_stub
 
@@ -168,6 +171,15 @@ module Google
                 @config
               end
 
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @firestore_stub.universe_domain
+              end
+
               ##
               # Create a new Firestore REST client object.
               #
@@ -195,8 +207,9 @@ module Google
                 credentials = @config.credentials
                 # Use self-signed JWT if the endpoint is unchanged from default,
                 # but only if the default endpoint does not have a region prefix.
-                enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
-                                         !@config.endpoint.split(".").first.include?("-")
+                enable_self_signed_jwt = @config.endpoint.nil? ||
+                                         (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
+                                         !@config.endpoint.split(".").first.include?("-"))
                 credentials ||= Credentials.default scope: @config.scope,
                                                     enable_self_signed_jwt: enable_self_signed_jwt
                 if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -206,13 +219,19 @@ module Google
                 @quota_project_id = @config.quota_project
                 @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+                @firestore_stub = ::Google::Cloud::Firestore::V1::Firestore::Rest::ServiceStub.new(
+                  endpoint: @config.endpoint,
+                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                  universe_domain: @config.universe_domain,
+                  credentials: credentials
+                )
+
                 @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
-                  config.endpoint = @config.endpoint
+                  config.endpoint = @firestore_stub.endpoint
+                  config.universe_domain = @firestore_stub.universe_domain
                 end
-
-                @firestore_stub = ::Google::Cloud::Firestore::V1::Firestore::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
               end
 
               ##
@@ -254,7 +273,10 @@ module Google
               #     Reads the document in a transaction.
               #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
               #     Reads the version of the document at the given time.
-              #     This may not be older than 270 seconds.
+              #
+              #     This must be a microsecond precision timestamp within the past one hour,
+              #     or if Point-in-Time Recovery is enabled, can additionally be a whole
+              #     minute timestamp within the past 7 days.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::Firestore::V1::Document]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -262,6 +284,22 @@ module Google
               # @return [::Google::Cloud::Firestore::V1::Document]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::GetDocumentRequest.new
+              #
+              #   # Call the get_document method.
+              #   result = client.get_document request
+              #
+              #   # The returned object is of type Google::Cloud::Firestore::V1::Document.
+              #   p result
+              #
               def get_document request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -358,7 +396,9 @@ module Google
               #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
               #     Perform the read at the provided time.
               #
-              #     This may not be older than 270 seconds.
+              #     This must be a microsecond precision timestamp within the past one hour,
+              #     or if Point-in-Time Recovery is enabled, can additionally be a whole
+              #     minute timestamp within the past 7 days.
               #   @param show_missing [::Boolean]
               #     If the list should show missing documents.
               #
@@ -376,6 +416,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Firestore::V1::Document>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::ListDocumentsRequest.new
+              #
+              #   # Call the list_documents method.
+              #   result = client.list_documents request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
+              #     # Each element is of type ::Google::Cloud::Firestore::V1::Document.
+              #     p item
+              #   end
+              #
               def list_documents request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -456,6 +516,22 @@ module Google
               # @return [::Google::Cloud::Firestore::V1::Document]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::UpdateDocumentRequest.new
+              #
+              #   # Call the update_document method.
+              #   result = client.update_document request
+              #
+              #   # The returned object is of type Google::Cloud::Firestore::V1::Document.
+              #   p result
+              #
               def update_document request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -522,6 +598,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::DeleteDocumentRequest.new
+              #
+              #   # Call the delete_document method.
+              #   result = client.delete_document request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_document request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -600,10 +692,32 @@ module Google
               #     stream.
               #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
               #     Reads documents as they were at the given time.
-              #     This may not be older than 270 seconds.
+              #
+              #     This must be a microsecond precision timestamp within the past one hour,
+              #     or if Point-in-Time Recovery is enabled, can additionally be a whole
+              #     minute timestamp within the past 7 days.
               # @return [::Enumerable<::Google::Cloud::Firestore::V1::BatchGetDocumentsResponse>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::BatchGetDocumentsRequest.new
+              #
+              #   # Call the batch_get_documents method to start streaming.
+              #   output = client.batch_get_documents request
+              #
+              #   # The returned object is a streamed enumerable yielding elements of type
+              #   # ::Google::Cloud::Firestore::V1::BatchGetDocumentsResponse
+              #   output.each do |current_response|
+              #     p current_response
+              #   end
+              #
               def batch_get_documents request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -675,6 +789,22 @@ module Google
               # @return [::Google::Cloud::Firestore::V1::BeginTransactionResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::BeginTransactionRequest.new
+              #
+              #   # Call the begin_transaction method.
+              #   result = client.begin_transaction request
+              #
+              #   # The returned object is of type Google::Cloud::Firestore::V1::BeginTransactionResponse.
+              #   p result
+              #
               def begin_transaction request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -744,6 +874,22 @@ module Google
               # @return [::Google::Cloud::Firestore::V1::CommitResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::CommitRequest.new
+              #
+              #   # Call the commit method.
+              #   result = client.commit request
+              #
+              #   # The returned object is of type Google::Cloud::Firestore::V1::CommitResponse.
+              #   p result
+              #
               def commit request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -809,6 +955,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::RollbackRequest.new
+              #
+              #   # Call the rollback method.
+              #   result = client.rollback request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def rollback request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -882,10 +1044,32 @@ module Google
               #     stream.
               #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
               #     Reads documents as they were at the given time.
-              #     This may not be older than 270 seconds.
+              #
+              #     This must be a microsecond precision timestamp within the past one hour,
+              #     or if Point-in-Time Recovery is enabled, can additionally be a whole
+              #     minute timestamp within the past 7 days.
               # @return [::Enumerable<::Google::Cloud::Firestore::V1::RunQueryResponse>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::RunQueryRequest.new
+              #
+              #   # Call the run_query method to start streaming.
+              #   output = client.run_query request
+              #
+              #   # The returned object is a streamed enumerable yielding elements of type
+              #   # ::Google::Cloud::Firestore::V1::RunQueryResponse
+              #   output.each do |current_response|
+              #     p current_response
+              #   end
+              #
               def run_query request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -977,12 +1161,31 @@ module Google
               #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
               #     Executes the query at the given timestamp.
               #
-              #     Requires:
-              #
-              #     * Cannot be more than 270 seconds in the past.
+              #     This must be a microsecond precision timestamp within the past one hour,
+              #     or if Point-in-Time Recovery is enabled, can additionally be a whole
+              #     minute timestamp within the past 7 days.
               # @return [::Enumerable<::Google::Cloud::Firestore::V1::RunAggregationQueryResponse>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::RunAggregationQueryRequest.new
+              #
+              #   # Call the run_aggregation_query method to start streaming.
+              #   output = client.run_aggregation_query request
+              #
+              #   # The returned object is a streamed enumerable yielding elements of type
+              #   # ::Google::Cloud::Firestore::V1::RunAggregationQueryResponse
+              #   output.each do |current_response|
+              #     p current_response
+              #   end
+              #
               def run_aggregation_query request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1086,7 +1289,10 @@ module Google
               #     2 partitions, to complete the total of 10 specified in `partition_count`.
               #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
               #     Reads documents as they were at the given time.
-              #     This may not be older than 270 seconds.
+              #
+              #     This must be a microsecond precision timestamp within the past one hour,
+              #     or if Point-in-Time Recovery is enabled, can additionally be a whole
+              #     minute timestamp within the past 7 days.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Firestore::V1::Cursor>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1094,6 +1300,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Firestore::V1::Cursor>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::PartitionQueryRequest.new
+              #
+              #   # Call the partition_query method.
+              #   result = client.partition_query request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
+              #     # Each element is of type ::Google::Cloud::Firestore::V1::Cursor.
+              #     p item
+              #   end
+              #
               def partition_query request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1160,7 +1386,10 @@ module Google
               #     {::Google::Cloud::Firestore::V1::ListCollectionIdsResponse ListCollectionIdsResponse}.
               #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
               #     Reads documents as they were at the given time.
-              #     This may not be older than 270 seconds.
+              #
+              #     This must be a microsecond precision timestamp within the past one hour,
+              #     or if Point-in-Time Recovery is enabled, can additionally be a whole
+              #     minute timestamp within the past 7 days.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::String>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1168,6 +1397,22 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::String>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::ListCollectionIdsRequest.new
+              #
+              #   # Call the list_collection_ids method.
+              #   result = client.list_collection_ids request
+              #
+              #   # The returned object is of type Google::Cloud::Firestore::V1::ListCollectionIdsResponse.
+              #   p result
+              #
               def list_collection_ids request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1249,6 +1494,22 @@ module Google
               # @return [::Google::Cloud::Firestore::V1::BatchWriteResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::BatchWriteRequest.new
+              #
+              #   # Call the batch_write method.
+              #   result = client.batch_write request
+              #
+              #   # The returned object is of type Google::Cloud::Firestore::V1::BatchWriteResponse.
+              #   p result
+              #
               def batch_write request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1327,6 +1588,22 @@ module Google
               # @return [::Google::Cloud::Firestore::V1::Document]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::CreateDocumentRequest.new
+              #
+              #   # Call the create_document method.
+              #   result = client.create_document request
+              #
+              #   # The returned object is of type Google::Cloud::Firestore::V1::Document.
+              #   p result
+              #
               def create_document request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1392,17 +1669,17 @@ module Google
               #   end
               #
               # @!attribute [rw] endpoint
-              #   The hostname or hostname:port of the service endpoint.
-              #   Defaults to `"firestore.googleapis.com"`.
-              #   @return [::String]
+              #   A custom service endpoint, as a hostname or hostname:port. The default is
+              #   nil, indicating to use the default endpoint in the current universe domain.
+              #   @return [::String,nil]
               # @!attribute [rw] credentials
               #   Credentials to send with calls. You may provide any of the following types:
               #    *  (`String`) The path to a service account key file in JSON format
               #    *  (`Hash`) A service account key as a Hash
               #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`nil`) indicating no credentials
               #   @return [::Object]
               # @!attribute [rw] scope
@@ -1431,11 +1708,20 @@ module Google
               # @!attribute [rw] quota_project
               #   A separate project against which to charge quota.
               #   @return [::String]
+              # @!attribute [rw] universe_domain
+              #   The universe domain within which to make requests. This determines the
+              #   default endpoint URL. The default value of nil uses the environment
+              #   universe (usually the default "googleapis.com" universe).
+              #   @return [::String,nil]
               #
               class Configuration
                 extend ::Gapic::Config
 
-                config_attr :endpoint,      "firestore.googleapis.com", ::String
+                # @private
+                # The endpoint specific to the default "googleapis.com" universe. Deprecated.
+                DEFAULT_ENDPOINT = "firestore.googleapis.com"
+
+                config_attr :endpoint,      nil, ::String, nil
                 config_attr :credentials,   nil do |value|
                   allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                   allowed.any? { |klass| klass === value }
@@ -1447,6 +1733,7 @@ module Google
                 config_attr :metadata,      nil, ::Hash, nil
                 config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                 config_attr :quota_project, nil, ::String, nil
+                config_attr :universe_domain, nil, ::String, nil
 
                 # @private
                 def initialize parent_config = nil