Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::Index.
Cloud Firestore indexes enable simple and complex queries against documents in a database.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#api_scope
def api_scope() -> ::Google::Cloud::Firestore::Admin::V1::Index::ApiScope
- (::Google::Cloud::Firestore::Admin::V1::Index::ApiScope) — The API scope supported by this index.
#api_scope=
def api_scope=(value) -> ::Google::Cloud::Firestore::Admin::V1::Index::ApiScope
- value (::Google::Cloud::Firestore::Admin::V1::Index::ApiScope) — The API scope supported by this index.
- (::Google::Cloud::Firestore::Admin::V1::Index::ApiScope) — The API scope supported by this index.
#fields
def fields() -> ::Array<::Google::Cloud::Firestore::Admin::V1::Index::IndexField>
-
(::Array<::Google::Cloud::Firestore::Admin::V1::Index::IndexField>) — The fields supported by this index.
For composite indexes, this requires a minimum of 2 and a maximum of 100 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.
#fields=
def fields=(value) -> ::Array<::Google::Cloud::Firestore::Admin::V1::Index::IndexField>
-
value (::Array<::Google::Cloud::Firestore::Admin::V1::Index::IndexField>) — The fields supported by this index.
For composite indexes, this requires a minimum of 2 and a maximum of 100 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.
-
(::Array<::Google::Cloud::Firestore::Admin::V1::Index::IndexField>) — The fields supported by this index.
For composite indexes, this requires a minimum of 2 and a maximum of 100 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.
#name
def name() -> ::String
-
(::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.
#name=
def name=(value) -> ::String
-
value (::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.
-
(::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.
#query_scope
def query_scope() -> ::Google::Cloud::Firestore::Admin::V1::Index::QueryScope
-
(::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.
#query_scope=
def query_scope=(value) -> ::Google::Cloud::Firestore::Admin::V1::Index::QueryScope
-
value (::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.
-
(::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.
#state
def state() -> ::Google::Cloud::Firestore::Admin::V1::Index::State
- (::Google::Cloud::Firestore::Admin::V1::Index::State) — Output only. The serving state of the index.
#state=
def state=(value) -> ::Google::Cloud::Firestore::Admin::V1::Index::State
- value (::Google::Cloud::Firestore::Admin::V1::Index::State) — Output only. The serving state of the index.
- (::Google::Cloud::Firestore::Admin::V1::Index::State) — Output only. The serving state of the index.