Package-level declarations

Types

Link copied to clipboard
class BackupSchedule : KotlinCustomResource

Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule with retention up to 7 days and one weekly backup schedule with retention up to 14 weeks. Auto-naming is currently not supported for this resource.

Link copied to clipboard
data class BackupScheduleArgs(val dailyRecurrence: Output<GoogleFirestoreAdminV1DailyRecurrenceArgs>? = null, val databaseId: Output<String>? = null, val project: Output<String>? = null, val retention: Output<String>? = null, val weeklyRecurrence: Output<GoogleFirestoreAdminV1WeeklyRecurrenceArgs>? = null) : ConvertibleToJava<BackupScheduleArgs>

Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule with retention up to 7 days and one weekly backup schedule with retention up to 14 weeks. Auto-naming is currently not supported for this resource.

Link copied to clipboard
Link copied to clipboard
object BackupScheduleMapper : ResourceMapper<BackupSchedule>
Link copied to clipboard
class Database : KotlinCustomResource

Create a database.

Link copied to clipboard
data class DatabaseArgs(val appEngineIntegrationMode: Output<DatabaseAppEngineIntegrationMode>? = null, val concurrencyMode: Output<DatabaseConcurrencyMode>? = null, val databaseId: Output<String>? = null, val deleteProtectionState: Output<DatabaseDeleteProtectionState>? = null, val etag: Output<String>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val type: Output<DatabaseType>? = null) : ConvertibleToJava<DatabaseArgs>

Create a database.

Link copied to clipboard
Link copied to clipboard
object DatabaseMapper : ResourceMapper<Database>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Index : KotlinCustomResource

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.

Link copied to clipboard
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.

Link copied to clipboard

Builder for IndexArgs.

Link copied to clipboard
object IndexMapper : ResourceMapper<Index>
Link copied to clipboard

Builder for Index.

Functions

Link copied to clipboard
Link copied to clipboard
suspend fun database(name: String, block: suspend DatabaseResourceBuilder.() -> Unit): Database
Link copied to clipboard
fun index(name: String): Index
suspend fun index(name: String, block: suspend IndexResourceBuilder.() -> Unit): Index