IndexArgs

data class IndexArgs(val collectionId: Output<String>? = null, val databaseId: Output<String>? = null, val fields: Output<List<GoogleFirestoreAdminV1beta1IndexFieldArgs>>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val state: Output<IndexState>? = null) : ConvertibleToJava<IndexArgs>

Creates the specified index. A newly created index's initial state is CREATING. On completion of the returned google.longrunning.Operation, the state will be READY. If the index already exists, the call will return an ALREADY_EXISTS status. During creation, the process could result in an error, in which case the index will move to the ERROR state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single field cannot be created.

Constructors

Link copied to clipboard
fun IndexArgs(collectionId: Output<String>? = null, databaseId: Output<String>? = null, fields: Output<List<GoogleFirestoreAdminV1beta1IndexFieldArgs>>? = null, name: Output<String>? = null, project: Output<String>? = null, state: Output<IndexState>? = null)

Functions

Link copied to clipboard
open override fun toJava(): IndexArgs

Properties

Link copied to clipboard
val collectionId: Output<String>? = null

The collection ID to which this index applies. Required.

Link copied to clipboard
val databaseId: Output<String>? = null
Link copied to clipboard

The fields to index.

Link copied to clipboard
val name: Output<String>? = null

The resource name of the index. Output only.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val state: Output<IndexState>? = null

The state of the index. Output only.