Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
class Release : KotlinCustomResource

Create a Release. Release names should reflect the developer's deployment practices. For example, the release name may include the environment name, application name, application version, or any other name meaningful to the developer. Once a Release refers to a Ruleset, the rules can be enforced by Firebase Rules-enabled services. More than one Release may be 'live' concurrently. Consider the following three Release names for projects/foo and the Ruleset to which they refer. Release Name -> Ruleset Name * projects/foo/releases/prod -> projects/foo/rulesets/uuid123 * projects/foo/releases/prod/beta -> projects/foo/rulesets/uuid123 * projects/foo/releases/prod/v23 -> projects/foo/rulesets/uuid456 The relationships reflect a Ruleset rollout in progress. The prod and prod/beta releases refer to the same Ruleset. However, prod/v23 refers to a new Ruleset. The Ruleset reference for a Release may be updated using the UpdateRelease method.

Link copied to clipboard
data class ReleaseArgs(val name: Output<String>? = null, val project: Output<String>? = null, val rulesetName: Output<String>? = null) : ConvertibleToJava<ReleaseArgs>

Create a Release. Release names should reflect the developer's deployment practices. For example, the release name may include the environment name, application name, application version, or any other name meaningful to the developer. Once a Release refers to a Ruleset, the rules can be enforced by Firebase Rules-enabled services. More than one Release may be 'live' concurrently. Consider the following three Release names for projects/foo and the Ruleset to which they refer. Release Name -> Ruleset Name * projects/foo/releases/prod -> projects/foo/rulesets/uuid123 * projects/foo/releases/prod/beta -> projects/foo/rulesets/uuid123 * projects/foo/releases/prod/v23 -> projects/foo/rulesets/uuid456 The relationships reflect a Ruleset rollout in progress. The prod and prod/beta releases refer to the same Ruleset. However, prod/v23 refers to a new Ruleset. The Ruleset reference for a Release may be updated using the UpdateRelease method.

Link copied to clipboard
Link copied to clipboard
object ReleaseMapper : ResourceMapper<Release>
Link copied to clipboard
Link copied to clipboard
class Ruleset : KotlinCustomResource

Create a Ruleset from Source. The Ruleset is given a unique generated name which is returned to the caller. Source containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of Source issues, use TestRuleset. Auto-naming is currently not supported for this resource.

Link copied to clipboard
data class RulesetArgs(val project: Output<String>? = null, val source: Output<SourceArgs>? = null) : ConvertibleToJava<RulesetArgs>

Create a Ruleset from Source. The Ruleset is given a unique generated name which is returned to the caller. Source containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of Source issues, use TestRuleset. Auto-naming is currently not supported for this resource.

Link copied to clipboard
Link copied to clipboard
object RulesetMapper : ResourceMapper<Ruleset>
Link copied to clipboard

Functions

Link copied to clipboard
fun release(name: String): Release
suspend fun release(name: String, block: suspend ReleaseResourceBuilder.() -> Unit): Release
Link copied to clipboard
fun ruleset(name: String): Ruleset
suspend fun ruleset(name: String, block: suspend RulesetResourceBuilder.() -> Unit): Ruleset