pulumi-gcp-kotlin/com.pulumi.gcp.firestore.kotlin

Package-level declarations

Types

class Database : KotlinCustomResource

A Cloud Firestore Database. If you wish to use Firestore with App Engine, use the gcp.appengine.Application resource instead. To get more information about Database, see:

DatabaseArgs

data class DatabaseArgs(val appEngineIntegrationMode: Output<String>? = null, val concurrencyMode: Output<String>? = null, val deleteProtectionState: Output<String>? = null, val locationId: Output<String>? = null, val name: Output<String>? = null, val pointInTimeRecoveryEnablement: Output<String>? = null, val project: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<DatabaseArgs>

A Cloud Firestore Database. If you wish to use Firestore with App Engine, use the gcp.appengine.Application resource instead. To get more information about Database, see:

DatabaseArgsBuilder

class DatabaseArgsBuilder

Builder for DatabaseArgs.

DatabaseMapper

object DatabaseMapper : ResourceMapper<Database>

DatabaseResourceBuilder

class DatabaseResourceBuilder

Builder for Database.

Document

class Document : KotlinCustomResource

In Cloud Firestore, the unit of storage is the document. A document is a lightweight record that contains fields, which map to values. Each document is identified by a name. To get more information about Document, see:

DocumentArgs

data class DocumentArgs(val collection: Output<String>? = null, val database: Output<String>? = null, val documentId: Output<String>? = null, val fields: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<DocumentArgs>

DocumentArgsBuilder

class DocumentArgsBuilder

Builder for DocumentArgs.

DocumentMapper

object DocumentMapper : ResourceMapper<Document>

DocumentResourceBuilder

class DocumentResourceBuilder

Builder for Document.

Field

class Field : KotlinCustomResource

Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id. To get more information about Field, see:

FieldArgs

data class FieldArgs(val collection: Output<String>? = null, val database: Output<String>? = null, val field: Output<String>? = null, val indexConfig: Output<FieldIndexConfigArgs>? = null, val project: Output<String>? = null, val ttlConfig: Output<FieldTtlConfigArgs>? = null) : ConvertibleToJava<FieldArgs>

Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id. To get more information about Field, see:

FieldArgsBuilder

class FieldArgsBuilder

Builder for FieldArgs.

FieldMapper

object FieldMapper : ResourceMapper<Field>

FieldResourceBuilder

class FieldResourceBuilder

Builder for Field.

Index

class Index : KotlinCustomResource

Cloud Firestore indexes enable simple and complex queries against documents in a database. This resource manages composite indexes and not single field indexes. To get more information about Index, see:

IndexArgs

data class IndexArgs(val collection: Output<String>? = null, val database: Output<String>? = null, val fields: Output<List<IndexFieldArgs>>? = null, val project: Output<String>? = null, val queryScope: Output<String>? = null) : ConvertibleToJava<IndexArgs>

IndexArgsBuilder

class IndexArgsBuilder

Builder for IndexArgs.

IndexMapper

object IndexMapper : ResourceMapper<Index>

IndexResourceBuilder

class IndexResourceBuilder

Builder for Index.

Functions

database

fun database(name: String): Database

suspend fun database(name: String, block: suspend DatabaseResourceBuilder.() -> Unit): Database

document

fun document(name: String): Document

suspend fun document(name: String, block: suspend DocumentResourceBuilder.() -> Unit): Document

field

fun field(name: String): Field

suspend fun field(name: String, block: suspend FieldResourceBuilder.() -> Unit): Field

index

fun index(name: String): Index

suspend fun index(name: String, block: suspend IndexResourceBuilder.() -> Unit): Index