google-apis-firestore_v1 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbd3cc7cb3136d0926fe77fb121b9064f609a81fe4b48a4108eae047b4f83cad
-  data.tar.gz: 74b80d44b7f41eb3a938679dc29a727a0db0ad7a341a979f9d156ec1ce8fba99
+  metadata.gz: 548967240acf5b9c9ed46e1bcf08d963c23466e4bd12c889b82023e2a06fc035
+  data.tar.gz: 58295b8bff2bb4f3f32624f44ec721eb48247d8e639e489529c870cafbcbcfa4
 SHA512:
-  metadata.gz: d926cfe58469ede46802fd2a69cd4130f8b7d623ac6c031cfdef12d67199440bcd190b7defe8af73ae67f35141e3eb4b9dec1ff2205d5e22df31beda3f738ddb
-  data.tar.gz: 0f09a44b1b579ead02f9a80f62c7dcb83d01a0974949c580b5f739d7ba72f248e7b160e9d82da0001bbc0fc395545244f61650048c8466b9a4bac45c862730db
+  metadata.gz: 78c8c0e0addddb18f1645ad4804ed8b833152ad3e6d42c431e89b203c0ad19170eb22b627dc2e90f19bddc8f13f72b0e5bfc10c2019da00a90e23c28d231cae5
+  data.tar.gz: 3b608f656c9a5ada6c1397efe6e09c374a5881b80bfe607d36ef8eb2d437b08b4549e54b3eaf4b052b97b951c7b025cae06b31dc0c41f612aad904d065b9e020

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release history for google-apis-firestore_v1
 
+### v0.21.0 (2022-06-17)
+
+* Regenerated from discovery document revision 20220604
+* Regenerated using generator version 0.6.0
+
 ### v0.20.0 (2022-05-07)
 
 * Regenerated from discovery document revision 20220428

data/lib/google/apis/firestore_v1/classes.rb

@@ -982,6 +982,14 @@ module Google
         # @return [String]
         attr_accessor :name
       
+        # The TTL (time-to-live) configuration for documents that have this `Field` set.
+        # Storing a timestamp value into a TTL-enabled field will be treated as the
+        # document's absolute expiration time. Using any other data type or leaving the
+        # field absent will disable the TTL for the individual document.
+        # Corresponds to the JSON property `ttlConfig`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1TtlConfig]
+        attr_accessor :ttl_config
+      
         def initialize(**args)
            update!(**args)
         end
@@ -990,6 +998,7 @@ module Google
         def update!(**args)
           @index_config = args[:index_config] if args.key?(:index_config)
           @name = args[:name] if args.key?(:name)
+          @ttl_config = args[:ttl_config] if args.key?(:ttl_config)
         end
       end
       
@@ -1038,6 +1047,11 @@ module Google
         # @return [String]
         attr_accessor :state
       
+        # Information about an TTL configuration change.
+        # Corresponds to the JSON property `ttlConfigDelta`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1TtlConfigDelta]
+        attr_accessor :ttl_config_delta
+      
         def initialize(**args)
            update!(**args)
         end
@@ -1051,6 +1065,7 @@ module Google
           @progress_documents = args[:progress_documents] if args.key?(:progress_documents)
           @start_time = args[:start_time] if args.key?(:start_time)
           @state = args[:state] if args.key?(:state)
+          @ttl_config_delta = args[:ttl_config_delta] if args.key?(:ttl_config_delta)
         end
       end
       
@@ -1466,6 +1481,47 @@ module Google
         end
       end
       
+      # The TTL (time-to-live) configuration for documents that have this `Field` set.
+      # Storing a timestamp value into a TTL-enabled field will be treated as the
+      # document's absolute expiration time. Using any other data type or leaving the
+      # field absent will disable the TTL for the individual document.
+      class GoogleFirestoreAdminV1TtlConfig
+        include Google::Apis::Core::Hashable
+      
+        # Output only. The state of the TTL configuration.
+        # Corresponds to the JSON property `state`
+        # @return [String]
+        attr_accessor :state
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @state = args[:state] if args.key?(:state)
+        end
+      end
+      
+      # Information about an TTL configuration change.
+      class GoogleFirestoreAdminV1TtlConfigDelta
+        include Google::Apis::Core::Hashable
+      
+        # Specifies how the TTL configuration is changing.
+        # Corresponds to the JSON property `changeType`
+        # @return [String]
+        attr_accessor :change_type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @change_type = args[:change_type] if args.key?(:change_type)
+        end
+      end
+      
       # Metadata related to the update database operation.
       class GoogleFirestoreAdminV1UpdateDatabaseMetadata
         include Google::Apis::Core::Hashable
@@ -1621,6 +1677,12 @@ module Google
         # @return [String]
         attr_accessor :page_token
       
+        # Reads documents as they were at the given time. This may not be older than 270
+        # seconds.
+        # Corresponds to the JSON property `readTime`
+        # @return [String]
+        attr_accessor :read_time
+      
         def initialize(**args)
            update!(**args)
         end
@@ -1629,6 +1691,7 @@ module Google
         def update!(**args)
           @page_size = args[:page_size] if args.key?(:page_size)
           @page_token = args[:page_token] if args.key?(:page_token)
+          @read_time = args[:read_time] if args.key?(:read_time)
         end
       end
       
@@ -1921,6 +1984,12 @@ module Google
         # @return [Fixnum]
         attr_accessor :partition_count
       
+        # Reads documents as they were at the given time. This may not be older than 270
+        # seconds.
+        # Corresponds to the JSON property `readTime`
+        # @return [String]
+        attr_accessor :read_time
+      
         # A Firestore query.
         # Corresponds to the JSON property `structuredQuery`
         # @return [Google::Apis::FirestoreV1::StructuredQuery]
@@ -1935,6 +2004,7 @@ module Google
           @page_size = args[:page_size] if args.key?(:page_size)
           @page_token = args[:page_token] if args.key?(:page_token)
           @partition_count = args[:partition_count] if args.key?(:partition_count)
+          @read_time = args[:read_time] if args.key?(:read_time)
           @structured_query = args[:structured_query] if args.key?(:structured_query)
         end
       end

data/lib/google/apis/firestore_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module FirestoreV1
       # Version of the google-apis-firestore_v1 gem
-      GEM_VERSION = "0.20.0"
+      GEM_VERSION = "0.21.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.4.1"
+      GENERATOR_VERSION = "0.6.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220428"
+      REVISION = "20220604"
     end
   end
 end

data/lib/google/apis/firestore_v1/representations.rb

@@ -280,6 +280,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1TtlConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleFirestoreAdminV1TtlConfigDelta
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1UpdateDatabaseMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -773,6 +785,8 @@ module Google
           property :index_config, as: 'indexConfig', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfig, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfig::Representation
       
           property :name, as: 'name'
+          property :ttl_config, as: 'ttlConfig', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1TtlConfig, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1TtlConfig::Representation
+      
         end
       end
       
@@ -789,6 +803,8 @@ module Google
       
           property :start_time, as: 'startTime'
           property :state, as: 'state'
+          property :ttl_config_delta, as: 'ttlConfigDelta', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1TtlConfigDelta, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1TtlConfigDelta::Representation
+      
         end
       end
       
@@ -909,6 +925,20 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1TtlConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :state, as: 'state'
+        end
+      end
+      
+      class GoogleFirestoreAdminV1TtlConfigDelta
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :change_type, as: 'changeType'
+        end
+      end
+      
       class GoogleFirestoreAdminV1UpdateDatabaseMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -955,6 +985,7 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :page_size, as: 'pageSize'
           property :page_token, as: 'pageToken'
+          property :read_time, as: 'readTime'
         end
       end
       
@@ -1044,6 +1075,7 @@ module Google
           property :page_size, as: 'pageSize'
           property :page_token, as: 'pageToken'
           property :partition_count, :numeric_string => true, as: 'partitionCount'
+          property :read_time, as: 'readTime'
           property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1::StructuredQuery, decorator: Google::Apis::FirestoreV1::StructuredQuery::Representation
       
         end

data/lib/google/apis/firestore_v1/service.rb

@@ -50,6 +50,50 @@ module Google
           @batch_path = 'batch'
         end
         
+        # Create a database.
+        # @param [String] parent
+        #   Required. A parent name of the form `projects/`project_id``
+        # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database] google_firestore_admin_v1_database_object
+        # @param [String] database_id
+        #   Required. The ID to use for the database, which will become the final
+        #   component of the database's resource name. This value should be 4-63
+        #   characters. Valid characters are /a-z-/ with first character a letter and the
+        #   last a letter or a number. Must not be UUID-like /[0-9a-f]`8`(-[0-9a-f]`4`)`3`-
+        #   [0-9a-f]`12`/. "(default)" database id is also valid.
+        # @param [Boolean] validate_only
+        #   If set, validate the request and preview the response, but do not actually
+        #   create the database.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FirestoreV1::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirestoreV1::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def create_project_database(parent, google_firestore_admin_v1_database_object = nil, database_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+parent}/databases', options)
+          command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database::Representation
+          command.request_object = google_firestore_admin_v1_database_object
+          command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
+          command.params['parent'] = parent unless parent.nil?
+          command.query['databaseId'] = database_id unless database_id.nil?
+          command.query['validateOnly'] = validate_only unless validate_only.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Exports a copy of all or a subset of documents from Google Cloud Firestore to
         # another storage system, such as Google Cloud Storage. Recent updates to
         # documents may not be reflected in the export. The export occurs in the

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.6'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.6'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.20.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.21.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Cloud Firestore API V1