google-cloud-firestore 1.0.0 → 1.1.0

data/lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/firestore_admin.rb

@@ -0,0 +1,161 @@
+# Copyright 2019 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.
+
+
+module Google
+  module Firestore
+    module Admin
+      module V1
+        # The request for {Google::Firestore::Admin::V1::FirestoreAdmin::CreateIndex FirestoreAdmin::CreateIndex}.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     A parent name of the form
+        #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
+        # @!attribute [rw] index
+        #   @return [Google::Firestore::Admin::V1::Index]
+        #     The composite index to create.
+        class CreateIndexRequest; end
+
+        # The request for {Google::Firestore::Admin::V1::FirestoreAdmin::ListIndexes FirestoreAdmin::ListIndexes}.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     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::Firestore::Admin::V1::FirestoreAdmin::ListIndexes FirestoreAdmin::ListIndexes}, that may be used to get the next
+        #     page of results.
+        class ListIndexesRequest; end
+
+        # The response for {Google::Firestore::Admin::V1::FirestoreAdmin::ListIndexes FirestoreAdmin::ListIndexes}.
+        # @!attribute [rw] indexes
+        #   @return [Array<Google::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; end
+
+        # The request for {Google::Firestore::Admin::V1::FirestoreAdmin::GetIndex FirestoreAdmin::GetIndex}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     A name of the form
+        #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
+        class GetIndexRequest; end
+
+        # The request for {Google::Firestore::Admin::V1::FirestoreAdmin::DeleteIndex FirestoreAdmin::DeleteIndex}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     A name of the form
+        #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
+        class DeleteIndexRequest; end
+
+        # The request for {Google::Firestore::Admin::V1::FirestoreAdmin::UpdateField FirestoreAdmin::UpdateField}.
+        # @!attribute [rw] field
+        #   @return [Google::Firestore::Admin::V1::Field]
+        #     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; end
+
+        # The request for {Google::Firestore::Admin::V1::FirestoreAdmin::GetField FirestoreAdmin::GetField}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     A name of the form
+        #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`
+        class GetFieldRequest; end
+
+        # The request for {Google::Firestore::Admin::V1::FirestoreAdmin::ListFields FirestoreAdmin::ListFields}.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     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::Firestore::Admin::V1::FirestoreAdmin::ListFields FirestoreAdmin::ListFields} only supports listing fields
+        #     that have been explicitly overridden. To issue this query, call
+        #     {Google::Firestore::Admin::V1::FirestoreAdmin::ListFields 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::Firestore::Admin::V1::FirestoreAdmin::ListFields FirestoreAdmin::ListFields}, that may be used to get the next
+        #     page of results.
+        class ListFieldsRequest; end
+
+        # The response for {Google::Firestore::Admin::V1::FirestoreAdmin::ListFields FirestoreAdmin::ListFields}.
+        # @!attribute [rw] fields
+        #   @return [Array<Google::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; end
+
+        # The request for {Google::Firestore::Admin::V1::FirestoreAdmin::ExportDocuments FirestoreAdmin::ExportDocuments}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     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; end
+
+        # The request for {Google::Firestore::Admin::V1::FirestoreAdmin::ImportDocuments FirestoreAdmin::ImportDocuments}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     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::Firestore::Admin::V1::ExportDocumentsResponse#output_uri_prefix}.
+        class ImportDocumentsRequest; end
+      end
+    end
+  end
+end

data/lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/index.rb

@@ -0,0 +1,139 @@
+# Copyright 2019 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.
+
+
+module Google
+  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::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::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::Firestore::Admin::V1::Index::State]
+        #     Output only.
+        #     The serving state of the index.
+        class Index
+          # 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::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::Firestore::Admin::V1::Index::IndexField::ArrayConfig]
+          #     Indicates that this field supports operations on `array_value`s.
+          class IndexField
+            # 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
+
+            # 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
+          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
+          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

data/lib/google/cloud/firestore/admin/v1/doc/google/longrunning/operations.rb

@@ -0,0 +1,51 @@
+# Copyright 2019 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.
+
+
+module Google
+  module Longrunning
+    # This resource represents a long-running operation that is the result of a
+    # network API call.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     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`.
+    # @!attribute [rw] metadata
+    #   @return [Google::Protobuf::Any]
+    #     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.
+    # @!attribute [rw] done
+    #   @return [true, false]
+    #     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.
+    # @!attribute [rw] error
+    #   @return [Google::Rpc::Status]
+    #     The error result of the operation in case of failure or cancellation.
+    # @!attribute [rw] response
+    #   @return [Google::Protobuf::Any]
+    #     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`.
+    class Operation; end
+  end
+end

data/lib/google/cloud/firestore/admin/v1/doc/google/protobuf/any.rb

@@ -0,0 +1,131 @@
+# Copyright 2019 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.
+
+
+module Google
+  module Protobuf
+    # `Any` contains an arbitrary serialized protocol buffer message along with a
+    # URL that describes the type of the serialized message.
+    #
+    # Protobuf library provides support to pack/unpack Any values in the form
+    # of utility functions or additional generated methods of the Any type.
+    #
+    # Example 1: Pack and unpack a message in C++.
+    #
+    #     Foo foo = ...;
+    #     Any any;
+    #     any.PackFrom(foo);
+    #     ...
+    #     if (any.UnpackTo(&foo)) {
+    #       ...
+    #     }
+    #
+    # Example 2: Pack and unpack a message in Java.
+    #
+    #     Foo foo = ...;
+    #     Any any = Any.pack(foo);
+    #     ...
+    #     if (any.is(Foo.class)) {
+    #       foo = any.unpack(Foo.class);
+    #     }
+    #
+    #  Example 3: Pack and unpack a message in Python.
+    #
+    #     foo = Foo(...)
+    #     any = Any()
+    #     any.Pack(foo)
+    #     ...
+    #     if any.Is(Foo.DESCRIPTOR):
+    #       any.Unpack(foo)
+    #       ...
+    #
+    #  Example 4: Pack and unpack a message in Go
+    #
+    #      foo := &pb.Foo{...}
+    #      any, err := ptypes.MarshalAny(foo)
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #        ...
+    #      }
+    #
+    # The pack methods provided by protobuf library will by default use
+    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
+    # methods only use the fully qualified type name after the last '/'
+    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
+    # name "y.z".
+    #
+    #
+    # = JSON
+    #
+    # The JSON representation of an `Any` value uses the regular
+    # representation of the deserialized, embedded message, with an
+    # additional field `@type` which contains the type URL. Example:
+    #
+    #     package google.profile;
+    #     message Person {
+    #       string first_name = 1;
+    #       string last_name = 2;
+    #     }
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.profile.Person",
+    #       "firstName": <string>,
+    #       "lastName": <string>
+    #     }
+    #
+    # If the embedded message type is well-known and has a custom JSON
+    # representation, that representation will be embedded adding a field
+    # `value` which holds the custom JSON in addition to the `@type`
+    # field. Example (for message {Google::Protobuf::Duration}):
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.protobuf.Duration",
+    #       "value": "1.212s"
+    #     }
+    # @!attribute [rw] type_url
+    #   @return [String]
+    #     A URL/resource name that uniquely identifies the type of the serialized
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. The last segment of the URL's path must represent
+    #     the fully qualified name of the type (as in
+    #     `path/google.protobuf.Duration`). The name should be in a canonical form
+    #     (e.g., leading "." is not accepted).
+    #
+    #     In practice, teams usually precompile into the binary all types that they
+    #     expect it to use in the context of Any. However, for URLs which use the
+    #     scheme `http`, `https`, or no scheme, one can optionally set up a type
+    #     server that maps type URLs to message definitions as follows:
+    #
+    #     * If no scheme is provided, `https` is assumed.
+    #     * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
+    #       value in binary format, or produce an error.
+    #     * Applications are allowed to cache lookup results based on the
+    #       URL, or have them precompiled into a binary to avoid any
+    #       lookup. Therefore, binary compatibility needs to be preserved
+    #       on changes to types. (Use versioned type names to manage
+    #       breaking changes.)
+    #
+    #     Note: this functionality is not currently available in the official
+    #     protobuf release, and it is not used for type URLs beginning with
+    #     type.googleapis.com.
+    #
+    #     Schemes other than `http`, `https` (or the empty scheme) might be
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any; end
+  end
+end