lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/index.rb in google-cloud-firestore-1.1.0 vs lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/index.rb in google-cloud-firestore-1.2.0

- old
+ new

@@ -19,12 +19,11 @@ 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. + # 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] @@ -48,12 +47,11 @@ # # 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. + # 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 @@ -99,9 +97,14 @@ # 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 \ No newline at end of file