pulumi-google-native-kotlin/com.pulumi.googlenative.firestore.v1.kotlin/IndexArgs

IndexArgs

data class IndexArgs(val apiScope: Output<IndexApiScope>? = null, val collectionGroupId: Output<String>? = null, val databaseId: Output<String>? = null, val fields: Output<List<GoogleFirestoreAdminV1IndexFieldArgs>>? = null, val project: Output<String>? = null, val queryScope: Output<IndexQueryScope>? = null) : ConvertibleToJava<IndexArgs>

Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata. Auto-naming is currently not supported for this resource.

Constructors

Link copied to clipboard
fun IndexArgs(apiScope: Output<IndexApiScope>? = null, collectionGroupId: Output<String>? = null, databaseId: Output<String>? = null, fields: Output<List<GoogleFirestoreAdminV1IndexFieldArgs>>? = null, project: Output<String>? = null, queryScope: Output<IndexQueryScope>? = null)

Functions

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

Properties

Link copied to clipboard
val apiScope: Output<IndexApiScope>? = null

The API scope supported by this index.

Link copied to clipboard
val collectionGroupId: Output<String>? = null
Link copied to clipboard
val databaseId: Output<String>? = null
Link copied to clipboard
val fields: Output<List<GoogleFirestoreAdminV1IndexFieldArgs>>? = null

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.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val queryScope: Output<IndexQueryScope>? = null

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.