google-cloud-firestore-admin-v1 0.1.0

data/proto_docs/google/firestore/admin/v1/firestore_admin.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        module V1
+          # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_index FirestoreAdmin.CreateIndex}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. A parent name of the form
+          #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
+          # @!attribute [rw] index
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Index]
+          #     Required. The composite index to create.
+          class CreateIndexRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_indexes FirestoreAdmin.ListIndexes}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. A parent name of the form
+          #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     The filter to apply to list results.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The number of results to return.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     A page token, returned from a previous call to
+          #     {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_indexes FirestoreAdmin.ListIndexes}, that may be used to get the next
+          #     page of results.
+          class ListIndexesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_indexes FirestoreAdmin.ListIndexes}.
+          # @!attribute [rw] indexes
+          #   @return [::Array<::Google::Cloud::Firestore::Admin::V1::Index>]
+          #     The requested indexes.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     A page token that may be used to request another page of results. If blank,
+          #     this is the last page.
+          class ListIndexesResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#get_index FirestoreAdmin.GetIndex}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. A name of the form
+          #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
+          class GetIndexRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#delete_index FirestoreAdmin.DeleteIndex}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. A name of the form
+          #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
+          class DeleteIndexRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#update_field FirestoreAdmin.UpdateField}.
+          # @!attribute [rw] field
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Field]
+          #     Required. The field to be updated.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     A mask, relative to the field. If specified, only configuration specified
+          #     by this field_mask will be updated in the field.
+          class UpdateFieldRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#get_field FirestoreAdmin.GetField}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. A name of the form
+          #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`
+          class GetFieldRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. A parent name of the form
+          #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     The filter to apply to list results. Currently,
+          #     {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} only supports listing fields
+          #     that have been explicitly overridden. To issue this query, call
+          #     {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with the filter set to
+          #     `indexConfig.usesAncestorConfig:false`.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The number of results to return.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     A page token, returned from a previous call to
+          #     {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields}, that may be used to get the next
+          #     page of results.
+          class ListFieldsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields}.
+          # @!attribute [rw] fields
+          #   @return [::Array<::Google::Cloud::Firestore::Admin::V1::Field>]
+          #     The requested fields.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     A page token that may be used to request another page of results. If blank,
+          #     this is the last page.
+          class ListFieldsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#export_documents FirestoreAdmin.ExportDocuments}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Database to export. Should be of the form:
+          #     `projects/{project_id}/databases/{database_id}`.
+          # @!attribute [rw] collection_ids
+          #   @return [::Array<::String>]
+          #     Which collection ids to export. Unspecified means all collections.
+          # @!attribute [rw] output_uri_prefix
+          #   @return [::String]
+          #     The output URI. Currently only supports Google Cloud Storage URIs of the
+          #     form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name
+          #     of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional
+          #     Google Cloud Storage namespace path. When
+          #     choosing a name, be sure to consider Google Cloud Storage naming
+          #     guidelines: https://cloud.google.com/storage/docs/naming.
+          #     If the URI is a bucket (without a namespace path), a prefix will be
+          #     generated based on the start time.
+          class ExportDocumentsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#import_documents FirestoreAdmin.ImportDocuments}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Database to import into. Should be of the form:
+          #     `projects/{project_id}/databases/{database_id}`.
+          # @!attribute [rw] collection_ids
+          #   @return [::Array<::String>]
+          #     Which collection ids to import. Unspecified means all collections included
+          #     in the import.
+          # @!attribute [rw] input_uri_prefix
+          #   @return [::String]
+          #     Location of the exported files.
+          #     This must match the output_uri_prefix of an ExportDocumentsResponse from
+          #     an export that has completed successfully.
+          #     See:
+          #     {::Google::Cloud::Firestore::Admin::V1::ExportDocumentsResponse#output_uri_prefix google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix}.
+          class ImportDocumentsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/firestore/admin/v1/index.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        module V1
+          # Cloud Firestore indexes enable simple and complex queries against
+          # documents in a database.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     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.
+          # @!attribute [rw] query_scope
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Index::QueryScope]
+          #     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.
+          # @!attribute [rw] fields
+          #   @return [::Array<::Google::Cloud::Firestore::Admin::V1::Index::IndexField>]
+          #     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.
+          # @!attribute [rw] state
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Index::State]
+          #     Output only. The serving state of the index.
+          class Index
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # A field in an index.
+            # The field_path describes which field is indexed, the value_mode describes
+            # how the field value is indexed.
+            # @!attribute [rw] field_path
+            #   @return [::String]
+            #     Can be __name__.
+            #     For single field indexes, this must match the name of the field or may
+            #     be omitted.
+            # @!attribute [rw] order
+            #   @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order]
+            #     Indicates that this field supports ordering by the specified order or
+            #     comparing using =, <, <=, >, >=.
+            # @!attribute [rw] array_config
+            #   @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig]
+            #     Indicates that this field supports operations on `array_value`s.
+            class IndexField
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # The supported orderings.
+              module Order
+                # The ordering is unspecified. Not a valid option.
+                ORDER_UNSPECIFIED = 0
+
+                # The field is ordered by ascending field value.
+                ASCENDING = 1
+
+                # The field is ordered by descending field value.
+                DESCENDING = 2
+              end
+
+              # The supported array value configurations.
+              module ArrayConfig
+                # The index does not support additional array queries.
+                ARRAY_CONFIG_UNSPECIFIED = 0
+
+                # The index supports array containment queries.
+                CONTAINS = 1
+              end
+            end
+
+            # Query Scope defines the scope at which a query is run. This is specified on
+            # a StructuredQuery's `from` field.
+            module QueryScope
+              # The query scope is unspecified. Not a valid option.
+              QUERY_SCOPE_UNSPECIFIED = 0
+
+              # 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 collection id specified by the index.
+              COLLECTION = 1
+
+              # Indexes with a collection group query scope specified allow queries
+              # against all collections that has the collection id specified by the
+              # index.
+              COLLECTION_GROUP = 2
+            end
+
+            # The state of an index. During index creation, an index will be in the
+            # `CREATING` state. If the index is created successfully, it will transition
+            # to the `READY` state. If the index creation encounters a problem, the index
+            # will transition to the `NEEDS_REPAIR` state.
+            module State
+              # The state is unspecified.
+              STATE_UNSPECIFIED = 0
+
+              # The index is being created.
+              # There is an active long-running operation for the index.
+              # The index is updated when writing a document.
+              # Some index data may exist.
+              CREATING = 1
+
+              # The index is ready to be used.
+              # The index is updated when writing a document.
+              # The index is fully populated from all stored documents it applies to.
+              READY = 2
+
+              # The index was being created, but something went wrong.
+              # There is no active long-running operation for the index,
+              # and the most recently finished long-running operation failed.
+              # The index is not updated when writing a document.
+              # Some index data may exist.
+              # Use the google.longrunning.Operations API to determine why the operation
+              # that last attempted to create this index failed, then re-create the
+              # index.
+              NEEDS_REPAIR = 3
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/firestore/admin/v1/location.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        module V1
+          # The metadata message for [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata].
+          class LocationMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/firestore/admin/v1/operation.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        module V1
+          # Metadata for {::Google::Longrunning::Operation google.longrunning.Operation} results from
+          # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_index FirestoreAdmin.CreateIndex}.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time this operation started.
+          # @!attribute [rw] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time this operation completed. Will be unset if operation still in
+          #     progress.
+          # @!attribute [rw] index
+          #   @return [::String]
+          #     The index resource that this operation is acting on. For example:
+          #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
+          # @!attribute [rw] state
+          #   @return [::Google::Cloud::Firestore::Admin::V1::OperationState]
+          #     The state of the operation.
+          # @!attribute [rw] progress_documents
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Progress]
+          #     The progress, in documents, of this operation.
+          # @!attribute [rw] progress_bytes
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Progress]
+          #     The progress, in bytes, of this operation.
+          class IndexOperationMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata for {::Google::Longrunning::Operation google.longrunning.Operation} results from
+          # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#update_field FirestoreAdmin.UpdateField}.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time this operation started.
+          # @!attribute [rw] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time this operation completed. Will be unset if operation still in
+          #     progress.
+          # @!attribute [rw] field
+          #   @return [::String]
+          #     The field resource that this operation is acting on. For example:
+          #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
+          # @!attribute [rw] index_config_deltas
+          #   @return [::Array<::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta>]
+          #     A list of {::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta IndexConfigDelta}, which describe the intent of this
+          #     operation.
+          # @!attribute [rw] state
+          #   @return [::Google::Cloud::Firestore::Admin::V1::OperationState]
+          #     The state of the operation.
+          # @!attribute [rw] progress_documents
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Progress]
+          #     The progress, in documents, of this operation.
+          # @!attribute [rw] progress_bytes
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Progress]
+          #     The progress, in bytes, of this operation.
+          class FieldOperationMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Information about an index configuration change.
+            # @!attribute [rw] change_type
+            #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta::ChangeType]
+            #     Specifies how the index is changing.
+            # @!attribute [rw] index
+            #   @return [::Google::Cloud::Firestore::Admin::V1::Index]
+            #     The index being changed.
+            class IndexConfigDelta
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Specifies how the index is changing.
+              module ChangeType
+                # The type of change is not specified or known.
+                CHANGE_TYPE_UNSPECIFIED = 0
+
+                # The single field index is being added.
+                ADD = 1
+
+                # The single field index is being removed.
+                REMOVE = 2
+              end
+            end
+          end
+
+          # Metadata for {::Google::Longrunning::Operation google.longrunning.Operation} results from
+          # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#export_documents FirestoreAdmin.ExportDocuments}.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time this operation started.
+          # @!attribute [rw] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time this operation completed. Will be unset if operation still in
+          #     progress.
+          # @!attribute [rw] operation_state
+          #   @return [::Google::Cloud::Firestore::Admin::V1::OperationState]
+          #     The state of the export operation.
+          # @!attribute [rw] progress_documents
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Progress]
+          #     The progress, in documents, of this operation.
+          # @!attribute [rw] progress_bytes
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Progress]
+          #     The progress, in bytes, of this operation.
+          # @!attribute [rw] collection_ids
+          #   @return [::Array<::String>]
+          #     Which collection ids are being exported.
+          # @!attribute [rw] output_uri_prefix
+          #   @return [::String]
+          #     Where the entities are being exported to.
+          class ExportDocumentsMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata for {::Google::Longrunning::Operation google.longrunning.Operation} results from
+          # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#import_documents FirestoreAdmin.ImportDocuments}.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time this operation started.
+          # @!attribute [rw] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time this operation completed. Will be unset if operation still in
+          #     progress.
+          # @!attribute [rw] operation_state
+          #   @return [::Google::Cloud::Firestore::Admin::V1::OperationState]
+          #     The state of the import operation.
+          # @!attribute [rw] progress_documents
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Progress]
+          #     The progress, in documents, of this operation.
+          # @!attribute [rw] progress_bytes
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Progress]
+          #     The progress, in bytes, of this operation.
+          # @!attribute [rw] collection_ids
+          #   @return [::Array<::String>]
+          #     Which collection ids are being imported.
+          # @!attribute [rw] input_uri_prefix
+          #   @return [::String]
+          #     The location of the documents being imported.
+          class ImportDocumentsMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Returned in the {::Google::Longrunning::Operation google.longrunning.Operation} response field.
+          # @!attribute [rw] output_uri_prefix
+          #   @return [::String]
+          #     Location of the output files. This can be used to begin an import
+          #     into Cloud Firestore (this project or another project) after the operation
+          #     completes successfully.
+          class ExportDocumentsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Describes the progress of the operation.
+          # Unit of work is generic and must be interpreted based on where {::Google::Cloud::Firestore::Admin::V1::Progress Progress}
+          # is used.
+          # @!attribute [rw] estimated_work
+          #   @return [::Integer]
+          #     The amount of work estimated.
+          # @!attribute [rw] completed_work
+          #   @return [::Integer]
+          #     The amount of work completed.
+          class Progress
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Describes the state of the operation.
+          module OperationState
+            # Unspecified.
+            OPERATION_STATE_UNSPECIFIED = 0
+
+            # Request is being prepared for processing.
+            INITIALIZING = 1
+
+            # Request is actively being processed.
+            PROCESSING = 2
+
+            # Request is in the process of being cancelled after user called
+            # google.longrunning.Operations.CancelOperation on the operation.
+            CANCELLING = 3
+
+            # Request has been processed and is in its finalization stage.
+            FINALIZING = 4
+
+            # Request has completed successfully.
+            SUCCESSFUL = 5
+
+            # Request has finished being processed, but encountered an error.
+            FAILED = 6
+
+            # Request has finished being cancelled after user called
+            # google.longrunning.Operations.CancelOperation.
+            CANCELLED = 7
+          end
+        end
+      end
+    end
+  end
+end