google-api-client 0.23.4 → 0.23.5

data/generated/google/apis/firestore_v1beta1/representations.rb

@@ -160,6 +160,36 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1beta1ExportDocumentsMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleFirestoreAdminV1beta1ExportDocumentsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleFirestoreAdminV1beta1ExportDocumentsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleFirestoreAdminV1beta1ImportDocumentsMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleFirestoreAdminV1beta1ImportDocumentsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1beta1Index
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -172,12 +202,30 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1beta1IndexOperationMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1beta1ListIndexesResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1beta1LocationMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleFirestoreAdminV1beta1Progress
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleLongrunningOperation
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -555,6 +603,59 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1beta1ExportDocumentsMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :collection_ids, as: 'collectionIds'
+          property :end_time, as: 'endTime'
+          property :operation_state, as: 'operationState'
+          property :output_uri_prefix, as: 'outputUriPrefix'
+          property :progress_bytes, as: 'progressBytes', class: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Progress, decorator: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Progress::Representation
+      
+          property :progress_documents, as: 'progressDocuments', class: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Progress, decorator: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Progress::Representation
+      
+          property :start_time, as: 'startTime'
+        end
+      end
+      
+      class GoogleFirestoreAdminV1beta1ExportDocumentsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :collection_ids, as: 'collectionIds'
+          property :output_uri_prefix, as: 'outputUriPrefix'
+        end
+      end
+      
+      class GoogleFirestoreAdminV1beta1ExportDocumentsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :output_uri_prefix, as: 'outputUriPrefix'
+        end
+      end
+      
+      class GoogleFirestoreAdminV1beta1ImportDocumentsMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :collection_ids, as: 'collectionIds'
+          property :end_time, as: 'endTime'
+          property :input_uri_prefix, as: 'inputUriPrefix'
+          property :operation_state, as: 'operationState'
+          property :progress_bytes, as: 'progressBytes', class: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Progress, decorator: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Progress::Representation
+      
+          property :progress_documents, as: 'progressDocuments', class: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Progress, decorator: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Progress::Representation
+      
+          property :start_time, as: 'startTime'
+        end
+      end
+      
+      class GoogleFirestoreAdminV1beta1ImportDocumentsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :collection_ids, as: 'collectionIds'
+          property :input_uri_prefix, as: 'inputUriPrefix'
+        end
+      end
+      
       class GoogleFirestoreAdminV1beta1Index
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -574,6 +675,19 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1beta1IndexOperationMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :cancelled, as: 'cancelled'
+          property :document_progress, as: 'documentProgress', class: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Progress, decorator: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Progress::Representation
+      
+          property :end_time, as: 'endTime'
+          property :index, as: 'index'
+          property :operation_type, as: 'operationType'
+          property :start_time, as: 'startTime'
+        end
+      end
+      
       class GoogleFirestoreAdminV1beta1ListIndexesResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -583,6 +697,20 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1beta1LocationMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
+      class GoogleFirestoreAdminV1beta1Progress
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :work_completed, :numeric_string => true, as: 'workCompleted'
+          property :work_estimated, :numeric_string => true, as: 'workEstimated'
+        end
+      end
+      
       class GoogleLongrunningOperation
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/generated/google/apis/firestore_v1beta1/service.rb

@@ -47,6 +47,85 @@ module Google
           @batch_path = 'batch'
         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
+        # background and its progress can be monitored and managed via the
+        # Operation resource that is created. The output of an export may only be
+        # used once the associated operation is done. If an export operation is
+        # cancelled before completion it may leave partial data behind in Google
+        # Cloud Storage.
+        # @param [String] name
+        #   Database to export. Should be of the form:
+        #   `projects/`project_id`/databases/`database_id``.
+        # @param [Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ExportDocumentsRequest] google_firestore_admin_v1beta1_export_documents_request_object
+        # @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::FirestoreV1beta1::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirestoreV1beta1::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 export_project_database_documents(name, google_firestore_admin_v1beta1_export_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:post, 'v1beta1/{+name}:exportDocuments', options)
+          command.request_representation = Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ExportDocumentsRequest::Representation
+          command.request_object = google_firestore_admin_v1beta1_export_documents_request_object
+          command.response_representation = Google::Apis::FirestoreV1beta1::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::FirestoreV1beta1::GoogleLongrunningOperation
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Imports documents into Google Cloud Firestore. Existing documents with the
+        # same name are overwritten. The import occurs in the background and its
+        # progress can be monitored and managed via the Operation resource that is
+        # created. If an ImportDocuments operation is cancelled, it is possible
+        # that a subset of the data has already been imported to Cloud Firestore.
+        # @param [String] name
+        #   Database to import into. Should be of the form:
+        #   `projects/`project_id`/databases/`database_id``.
+        # @param [Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ImportDocumentsRequest] google_firestore_admin_v1beta1_import_documents_request_object
+        # @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::FirestoreV1beta1::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirestoreV1beta1::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 import_project_database_documents(name, google_firestore_admin_v1beta1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:post, 'v1beta1/{+name}:importDocuments', options)
+          command.request_representation = Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ImportDocumentsRequest::Representation
+          command.request_object = google_firestore_admin_v1beta1_import_documents_request_object
+          command.response_representation = Google::Apis::FirestoreV1beta1::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::FirestoreV1beta1::GoogleLongrunningOperation
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets multiple documents.
         # Documents returned by this method are not guaranteed to be returned in the
         # same order that they were requested.

data/generated/google/apis/firestore_v1beta2.rb

@@ -0,0 +1,37 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/firestore_v1beta2/service.rb'
+require 'google/apis/firestore_v1beta2/classes.rb'
+require 'google/apis/firestore_v1beta2/representations.rb'
+
+module Google
+  module Apis
+    # Cloud Firestore API
+    #
+    # 
+    #
+    # @see https://cloud.google.com/firestore
+    module FirestoreV1beta2
+      VERSION = 'V1beta2'
+      REVISION = '20180806'
+
+      # View and manage your data across Google Cloud Platform services
+      AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
+
+      # View and manage your Google Cloud Datastore data
+      AUTH_DATASTORE = 'https://www.googleapis.com/auth/datastore'
+    end
+  end
+end

data/generated/google/apis/firestore_v1beta2/classes.rb

@@ -0,0 +1,531 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'date'
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module FirestoreV1beta2
+      
+      # Represents a single field in the database.
+      # Fields are grouped by their "Collection Group", which represent all
+      # collections in the database with the same id.
+      class GoogleFirestoreAdminV1beta2Field
+        include Google::Apis::Core::Hashable
+      
+        # The index configuration for this field.
+        # Corresponds to the JSON property `indexConfig`
+        # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2IndexConfig]
+        attr_accessor :index_config
+      
+        # A field name of the form
+        # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id`
+        # /fields/`field_path``
+        # A field path may be a simple field name, e.g. `address` or a path to fields
+        # within map_value , e.g. `address.city`,
+        # or a special field path. The only valid special field is `*`, which
+        # represents any field.
+        # Field paths may be quoted using ` (backtick). The only character that needs
+        # to be escaped within a quoted field path is the backtick character itself,
+        # escaped using a backslash. Special characters in field paths that
+        # must be quoted include: `*`, `.`,
+        # ``` (backtick), `[`, `]`, as well as any ascii symbolic characters.
+        # Examples:
+        # (Note: Comments here are written in markdown syntax, so there is an
+        # additional layer of backticks to represent a code block)
+        # `\`address.city\`` represents a field named `address.city`, not the map key
+        # `city` in the field `address`.
+        # `\`*\`` represents a field named `*`, not any field.
+        # A special `Field` contains the default indexing settings for all fields.
+        # This field's resource name is:
+        # `projects/`project_id`/databases/`database_id`/collectionGroups/__default__/
+        # fields/*`
+        # Indexes defined on this `Field` will be applied to all fields which do not
+        # have their own `Field` index configuration.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @index_config = args[:index_config] if args.key?(:index_config)
+          @name = args[:name] if args.key?(:name)
+        end
+      end
+      
+      # Metadata for google.longrunning.Operation results from
+      # FirestoreAdmin.UpdateField.
+      class GoogleFirestoreAdminV1beta2FieldOperationMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Describes the progress of the operation.
+        # Unit of work is generic and must be interpreted based on where Progress
+        # is used.
+        # Corresponds to the JSON property `bytesProgress`
+        # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress]
+        attr_accessor :bytes_progress
+      
+        # Describes the progress of the operation.
+        # Unit of work is generic and must be interpreted based on where Progress
+        # is used.
+        # Corresponds to the JSON property `documentProgress`
+        # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress]
+        attr_accessor :document_progress
+      
+        # The time this operation completed. Will be unset if operation still in
+        # progress.
+        # Corresponds to the JSON property `endTime`
+        # @return [String]
+        attr_accessor :end_time
+      
+        # The field resource that this operation is acting on. For example:
+        # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id`
+        # /fields/`field_path``
+        # Corresponds to the JSON property `field`
+        # @return [String]
+        attr_accessor :field
+      
+        # A list of IndexConfigDelta, which describe the intent of this
+        # operation.
+        # Corresponds to the JSON property `indexConfigDeltas`
+        # @return [Array<Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2IndexConfigDelta>]
+        attr_accessor :index_config_deltas
+      
+        # The time this operation started.
+        # Corresponds to the JSON property `startTime`
+        # @return [String]
+        attr_accessor :start_time
+      
+        # The state of the operation.
+        # 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)
+          @bytes_progress = args[:bytes_progress] if args.key?(:bytes_progress)
+          @document_progress = args[:document_progress] if args.key?(:document_progress)
+          @end_time = args[:end_time] if args.key?(:end_time)
+          @field = args[:field] if args.key?(:field)
+          @index_config_deltas = args[:index_config_deltas] if args.key?(:index_config_deltas)
+          @start_time = args[:start_time] if args.key?(:start_time)
+          @state = args[:state] if args.key?(:state)
+        end
+      end
+      
+      # Cloud Firestore indexes enable simple and complex queries against
+      # documents in a database.
+      class GoogleFirestoreAdminV1beta2Index
+        include Google::Apis::Core::Hashable
+      
+        # The fields supported by this index.
+        # For composite indexes, this is always 2 or more fields.
+        # The last field entry is always for the field path `__name__`. If, on
+        # creation, `__name__` was not specified as the last field, it will be added
+        # automatically with the same direction as that of the last field defined. If
+        # the final field in a composite index is not directional, the `__name__`
+        # will be ordered ASCENDING (unless explicitly specified).
+        # For single field indexes, this will always be exactly one entry with a
+        # field path equal to the field path of the associated field.
+        # Corresponds to the JSON property `fields`
+        # @return [Array<Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2IndexField>]
+        attr_accessor :fields
+      
+        # Output only.
+        # A server defined name for this index.
+        # The form of this name for composite indexes will be:
+        # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id`
+        # /indexes/`composite_index_id``
+        # For single field indexes, this field will be empty.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Indexes with a collection query scope specified allow queries
+        # against a collection that is the child of a specific document, specified at
+        # query time, and that has the same collection id.
+        # Indexes with a collection group query scope specified allow queries against
+        # all collections descended from a specific document, specified at query
+        # time, and that have the same collection id as this index.
+        # Corresponds to the JSON property `queryScope`
+        # @return [String]
+        attr_accessor :query_scope
+      
+        # Output only.
+        # The serving state of the index.
+        # 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)
+          @fields = args[:fields] if args.key?(:fields)
+          @name = args[:name] if args.key?(:name)
+          @query_scope = args[:query_scope] if args.key?(:query_scope)
+          @state = args[:state] if args.key?(:state)
+        end
+      end
+      
+      # The index configuration for this field.
+      class GoogleFirestoreAdminV1beta2IndexConfig
+        include Google::Apis::Core::Hashable
+      
+        # Output only.
+        # Specifies the resource name of the `Field` from which this field's
+        # index configuration is set (when `uses_ancestor_config` is true),
+        # or from which it *would* be set if this field had no index configuration
+        # (when `uses_ancestor_config` is false).
+        # Corresponds to the JSON property `ancestorField`
+        # @return [String]
+        attr_accessor :ancestor_field
+      
+        # The indexes supported for this field.
+        # Corresponds to the JSON property `indexes`
+        # @return [Array<Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Index>]
+        attr_accessor :indexes
+      
+        # Output only
+        # When true, the `Field`'s index configuration is in the process of being
+        # reverted. Once complete, the index config will transition to the same
+        # state as the field specified by `ancestor_field`, at which point
+        # `uses_ancestor_config` will be `true` and `reverting` will be `false`.
+        # Corresponds to the JSON property `reverting`
+        # @return [Boolean]
+        attr_accessor :reverting
+        alias_method :reverting?, :reverting
+      
+        # Output only.
+        # When true, the `Field`'s index configuration is set from the
+        # configuration specified by the `ancestor_field`.
+        # When false, the `Field`'s index configuration is defined explicitly.
+        # Corresponds to the JSON property `usesAncestorConfig`
+        # @return [Boolean]
+        attr_accessor :uses_ancestor_config
+        alias_method :uses_ancestor_config?, :uses_ancestor_config
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @ancestor_field = args[:ancestor_field] if args.key?(:ancestor_field)
+          @indexes = args[:indexes] if args.key?(:indexes)
+          @reverting = args[:reverting] if args.key?(:reverting)
+          @uses_ancestor_config = args[:uses_ancestor_config] if args.key?(:uses_ancestor_config)
+        end
+      end
+      
+      # Information about an index configuration change.
+      class GoogleFirestoreAdminV1beta2IndexConfigDelta
+        include Google::Apis::Core::Hashable
+      
+        # Specifies how the index is changing.
+        # Corresponds to the JSON property `changeType`
+        # @return [String]
+        attr_accessor :change_type
+      
+        # Cloud Firestore indexes enable simple and complex queries against
+        # documents in a database.
+        # Corresponds to the JSON property `index`
+        # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Index]
+        attr_accessor :index
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @change_type = args[:change_type] if args.key?(:change_type)
+          @index = args[:index] if args.key?(:index)
+        end
+      end
+      
+      # A field in an index.
+      # The field_path describes which field is indexed, the value_mode describes
+      # how the field value is indexed.
+      class GoogleFirestoreAdminV1beta2IndexField
+        include Google::Apis::Core::Hashable
+      
+        # Indicates that this field supports operations on `array_value`s.
+        # Corresponds to the JSON property `arrayConfig`
+        # @return [String]
+        attr_accessor :array_config
+      
+        # Can be __name__.
+        # For single field indexes, this must match the name of the field or may
+        # be omitted.
+        # Corresponds to the JSON property `fieldPath`
+        # @return [String]
+        attr_accessor :field_path
+      
+        # Indicates that this field supports ordering by the specified order or
+        # comparing using =, <, <=, >, >=.
+        # Corresponds to the JSON property `order`
+        # @return [String]
+        attr_accessor :order
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @array_config = args[:array_config] if args.key?(:array_config)
+          @field_path = args[:field_path] if args.key?(:field_path)
+          @order = args[:order] if args.key?(:order)
+        end
+      end
+      
+      # The response for FirestoreAdmin.ListFields.
+      class GoogleFirestoreAdminV1beta2ListFieldsResponse
+        include Google::Apis::Core::Hashable
+      
+        # The requested fields.
+        # Corresponds to the JSON property `fields`
+        # @return [Array<Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Field>]
+        attr_accessor :fields
+      
+        # A page token that may be used to request another page of results. If blank,
+        # this is the last page.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @fields = args[:fields] if args.key?(:fields)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+        end
+      end
+      
+      # Describes the progress of the operation.
+      # Unit of work is generic and must be interpreted based on where Progress
+      # is used.
+      class GoogleFirestoreAdminV1beta2Progress
+        include Google::Apis::Core::Hashable
+      
+        # The amount of work completed.
+        # Corresponds to the JSON property `completedWork`
+        # @return [Fixnum]
+        attr_accessor :completed_work
+      
+        # The amount of work estimated.
+        # Corresponds to the JSON property `estimatedWork`
+        # @return [Fixnum]
+        attr_accessor :estimated_work
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @completed_work = args[:completed_work] if args.key?(:completed_work)
+          @estimated_work = args[:estimated_work] if args.key?(:estimated_work)
+        end
+      end
+      
+      # This resource represents a long-running operation that is the result of a
+      # network API call.
+      class GoogleLongrunningOperation
+        include Google::Apis::Core::Hashable
+      
+        # If the value is `false`, it means the operation is still in progress.
+        # If `true`, the operation is completed, and either `error` or `response` is
+        # available.
+        # Corresponds to the JSON property `done`
+        # @return [Boolean]
+        attr_accessor :done
+        alias_method :done?, :done
+      
+        # The `Status` type defines a logical error model that is suitable for different
+        # programming environments, including REST APIs and RPC APIs. It is used by
+        # [gRPC](https://github.com/grpc). The error model is designed to be:
+        # - Simple to use and understand for most users
+        # - Flexible enough to meet unexpected needs
+        # # Overview
+        # The `Status` message contains three pieces of data: error code, error message,
+        # and error details. The error code should be an enum value of
+        # google.rpc.Code, but it may accept additional error codes if needed.  The
+        # error message should be a developer-facing English message that helps
+        # developers *understand* and *resolve* the error. If a localized user-facing
+        # error message is needed, put the localized message in the error details or
+        # localize it in the client. The optional error details may contain arbitrary
+        # information about the error. There is a predefined set of error detail types
+        # in the package `google.rpc` that can be used for common error conditions.
+        # # Language mapping
+        # The `Status` message is the logical representation of the error model, but it
+        # is not necessarily the actual wire format. When the `Status` message is
+        # exposed in different client libraries and different wire protocols, it can be
+        # mapped differently. For example, it will likely be mapped to some exceptions
+        # in Java, but more likely mapped to some error codes in C.
+        # # Other uses
+        # The error model and the `Status` message can be used in a variety of
+        # environments, either with or without APIs, to provide a
+        # consistent developer experience across different environments.
+        # Example uses of this error model include:
+        # - Partial errors. If a service needs to return partial errors to the client,
+        # it may embed the `Status` in the normal response to indicate the partial
+        # errors.
+        # - Workflow errors. A typical workflow has multiple steps. Each step may
+        # have a `Status` message for error reporting.
+        # - Batch operations. If a client uses batch request and batch response, the
+        # `Status` message should be used directly inside batch response, one for
+        # each error sub-response.
+        # - Asynchronous operations. If an API call embeds asynchronous operation
+        # results in its response, the status of those operations should be
+        # represented directly using the `Status` message.
+        # - Logging. If some API errors are stored in logs, the message `Status` could
+        # be used directly after any stripping needed for security/privacy reasons.
+        # Corresponds to the JSON property `error`
+        # @return [Google::Apis::FirestoreV1beta2::Status]
+        attr_accessor :error
+      
+        # Service-specific metadata associated with the operation.  It typically
+        # contains progress information and common metadata such as create time.
+        # Some services might not provide such metadata.  Any method that returns a
+        # long-running operation should document the metadata type, if any.
+        # Corresponds to the JSON property `metadata`
+        # @return [Hash<String,Object>]
+        attr_accessor :metadata
+      
+        # The server-assigned name, which is only unique within the same service that
+        # originally returns it. If you use the default HTTP mapping, the
+        # `name` should have the format of `operations/some/unique/name`.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # The normal response of the operation in case of success.  If the original
+        # method returns no data on success, such as `Delete`, the response is
+        # `google.protobuf.Empty`.  If the original method is standard
+        # `Get`/`Create`/`Update`, the response should be the resource.  For other
+        # methods, the response should have the type `XxxResponse`, where `Xxx`
+        # is the original method name.  For example, if the original method name
+        # is `TakeSnapshot()`, the inferred response type is
+        # `TakeSnapshotResponse`.
+        # Corresponds to the JSON property `response`
+        # @return [Hash<String,Object>]
+        attr_accessor :response
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @done = args[:done] if args.key?(:done)
+          @error = args[:error] if args.key?(:error)
+          @metadata = args[:metadata] if args.key?(:metadata)
+          @name = args[:name] if args.key?(:name)
+          @response = args[:response] if args.key?(:response)
+        end
+      end
+      
+      # The `Status` type defines a logical error model that is suitable for different
+      # programming environments, including REST APIs and RPC APIs. It is used by
+      # [gRPC](https://github.com/grpc). The error model is designed to be:
+      # - Simple to use and understand for most users
+      # - Flexible enough to meet unexpected needs
+      # # Overview
+      # The `Status` message contains three pieces of data: error code, error message,
+      # and error details. The error code should be an enum value of
+      # google.rpc.Code, but it may accept additional error codes if needed.  The
+      # error message should be a developer-facing English message that helps
+      # developers *understand* and *resolve* the error. If a localized user-facing
+      # error message is needed, put the localized message in the error details or
+      # localize it in the client. The optional error details may contain arbitrary
+      # information about the error. There is a predefined set of error detail types
+      # in the package `google.rpc` that can be used for common error conditions.
+      # # Language mapping
+      # The `Status` message is the logical representation of the error model, but it
+      # is not necessarily the actual wire format. When the `Status` message is
+      # exposed in different client libraries and different wire protocols, it can be
+      # mapped differently. For example, it will likely be mapped to some exceptions
+      # in Java, but more likely mapped to some error codes in C.
+      # # Other uses
+      # The error model and the `Status` message can be used in a variety of
+      # environments, either with or without APIs, to provide a
+      # consistent developer experience across different environments.
+      # Example uses of this error model include:
+      # - Partial errors. If a service needs to return partial errors to the client,
+      # it may embed the `Status` in the normal response to indicate the partial
+      # errors.
+      # - Workflow errors. A typical workflow has multiple steps. Each step may
+      # have a `Status` message for error reporting.
+      # - Batch operations. If a client uses batch request and batch response, the
+      # `Status` message should be used directly inside batch response, one for
+      # each error sub-response.
+      # - Asynchronous operations. If an API call embeds asynchronous operation
+      # results in its response, the status of those operations should be
+      # represented directly using the `Status` message.
+      # - Logging. If some API errors are stored in logs, the message `Status` could
+      # be used directly after any stripping needed for security/privacy reasons.
+      class Status
+        include Google::Apis::Core::Hashable
+      
+        # The status code, which should be an enum value of google.rpc.Code.
+        # Corresponds to the JSON property `code`
+        # @return [Fixnum]
+        attr_accessor :code
+      
+        # A list of messages that carry the error details.  There is a common set of
+        # message types for APIs to use.
+        # Corresponds to the JSON property `details`
+        # @return [Array<Hash<String,Object>>]
+        attr_accessor :details
+      
+        # A developer-facing error message, which should be in English. Any
+        # user-facing error message should be localized and sent in the
+        # google.rpc.Status.details field, or localized by the client.
+        # Corresponds to the JSON property `message`
+        # @return [String]
+        attr_accessor :message
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @code = args[:code] if args.key?(:code)
+          @details = args[:details] if args.key?(:details)
+          @message = args[:message] if args.key?(:message)
+        end
+      end
+    end
+  end
+end