pulumi-google-native-kotlin/com.pulumi.googlenative.firestore.v1beta2.kotlin.enums/IndexQueryScope

IndexQueryScope

enum IndexQueryScope : Enum<IndexQueryScope> , ConvertibleToJava<IndexQueryScope>

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.

Entries

QueryScopeUnspecified

The query scope is unspecified. Not a valid option.

Collection

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.

CollectionGroup

Indexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index.

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<IndexQueryScope>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

javaValue

val javaValue: IndexQueryScope

name

val name: String

ordinal

val ordinal: Int

Functions

toJava

open override fun toJava(): IndexQueryScope

valueOf

fun valueOf(value: String): IndexQueryScope

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<IndexQueryScope>

Returns an array containing the constants of this enum type, in the order they're declared.