FirestoreIndex

Property Value
Google Cloud Service Name Cloud Firestore
Google Cloud Service Documentation /firestore/docs/
Google Cloud REST Resource Name v1.projects.databases.collectionGroups.indexes
Google Cloud REST Resource Documentation /firestore/docs/reference/rest/v1/projects.databases.collectionGroups.indexes
Config Connector Resource Short Names gcpfirestoreindex
gcpfirestoreindexes
firestoreindex
Config Connector Service Name firestore.googleapis.com
Config Connector Resource Fully Qualified Name firestoreindexes.firestore.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No

Custom Resource Definition Properties

Annotations

Fields
cnrm.cloud.google.com/project-id

Spec

Schema

collection: string
database: string
fields:
- arrayConfig: string
  fieldPath: string
  order: string
queryScope: string
Fields

collection

Required

string

The collection being indexed.

database

Optional

string

The Firestore database id. Defaults to '"(default)"'.

fields

Required

list (object)

fields.[]

Required

object

fields.[].arrayConfig

Optional

string

Indicates that this field supports operations on arrayValues. Only one of 'order' and 'arrayConfig' can be specified. Possible values: ["CONTAINS"]

fields.[].fieldPath

Optional

string

Name of the field.

fields.[].order

Optional

string

Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=. Only one of 'order' and 'arrayConfig' can be specified. Possible values: ["ASCENDING", "DESCENDING"]

queryScope

Optional

string

The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP"]

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
name: string
Fields
conditions

list (object)

conditions.[]

object

conditions.[].lastTransitionTime

string

Last time the condition transitioned from one status to another.

conditions.[].message

string

Human-readable message indicating details about last transition.

conditions.[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.

conditions.[].status

string

Status is the status of the condition. Can be True, False, Unknown.

conditions.[].type

string

Type is the type of the condition.

name

string

A server defined name for this index. Format: 'projects/{{project}}/databases/{{database}}/collectionGroups/{{collection}}/indexes/{{server_generated_id}}'

Sample YAML(s)

Typical Use Case

# 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
#
#     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.

apiVersion: firestore.cnrm.cloud.google.com/v1beta1
kind: FirestoreIndex
metadata:
  name: firestoreindex-sample
spec:
  collection: sample-collection
  fields:
  - fieldPath: field1
    order: ASCENDING
  - fieldPath: field2
    order: DESCENDING
  queryScope: COLLECTION